Changeset - b688a2a1b189
[Not reviewed]
stable
0 4 0
Mads Kiilerich (mads) - 6 years ago 2020-06-08 16:05:21
mads@kiilerich.com
Grafted from: c7a4831fa7f3
docs: clarify that MariaDB is supported, with slight preference for this more free option
4 files changed with 4 insertions and 3 deletions:
0 comments (0 inline, 0 general)
docs/setup.rst
Show inline comments
 
@@ -21,13 +21,13 @@ settings, and logging. Extra settings ca
 
    kallithea-cli config-create my.ini host=8.8.8.8 "[handler_console]" formatter=color_formatter
 

	
 
Next, you need to create the databases used by Kallithea. It is recommended to
 
use PostgreSQL or SQLite (default). If you choose a database other than the
 
default, ensure you properly adjust the database URL in your ``my.ini``
 
configuration file to use this other database. Kallithea currently supports
 
PostgreSQL, SQLite and MySQL databases. Create the database by running
 
PostgreSQL, SQLite and MariaDB/MySQL databases. Create the database by running
 
the following command::
 

	
 
    kallithea-cli db-create -c my.ini
 

	
 
This will prompt you for a "root" path. This "root" path is the location where
 
Kallithea will store all of its repositories on the current machine. After
docs/upgrade.rst
Show inline comments
 
@@ -48,13 +48,13 @@ Back up your database
 
If using SQLite, simply make a copy of the Kallithea database (``.db``)
 
file.
 

	
 
If using PostgreSQL, please consult the documentation for the ``pg_dump``
 
utility.
 

	
 
If using MySQL, please consult the documentation for the ``mysqldump``
 
If using MariaDB/MySQL, please consult the documentation for the ``mysqldump``
 
utility.
 

	
 
Look for ``sqlalchemy.url`` in your configuration file to determine
 
database type, settings, location, etc. If you were running Kallithea 0.3.x or
 
older, this was ``sqlalchemy.db1.url``.
 

	
docs/usage/performance.rst
Show inline comments
 
@@ -37,13 +37,13 @@ Database
 
--------
 

	
 
SQLite is a good option when having a small load on the system. But due to
 
locking issues with SQLite, it is not recommended to use it for larger
 
deployments.
 

	
 
Switching to MySQL or PostgreSQL will result in an immediate performance
 
Switching to PostgreSQL or MariaDB/MySQL will result in an immediate performance
 
increase. A tool like SQLAlchemyGrate_ can be used for migrating to another
 
database platform.
 

	
 

	
 
Horizontal scaling
 
------------------
kallithea/lib/paster_commands/template.ini.mako
Show inline comments
 
@@ -460,12 +460,13 @@ sqlalchemy.url = sqlite:///%(here)s/kall
 
<%text>##</%text> POSTGRESQL
 
sqlalchemy.url = postgresql://user:pass@localhost/kallithea
 

	
 
%elif database_engine == 'mysql':
 
<%text>##</%text> MySQL
 
sqlalchemy.url = mysql://user:pass@localhost/kallithea?charset=utf8
 
<%text>##</%text> Note: the mysql:// prefix should also be used for MariaDB
 

	
 
%endif
 
<%text>##</%text> see sqlalchemy docs for other backends
 

	
 
sqlalchemy.pool_recycle = 3600
 

	
0 comments (0 inline, 0 general)