changeset 8443:b688a2a1b189 stable

docs: clarify that MariaDB is supported, with slight preference for this more free option
author Mads Kiilerich <mads@kiilerich.com>
date Mon, 08 Jun 2020 16:05:21 +0200
parents 75b1994e4959
children 850f096505ac
files docs/setup.rst docs/upgrade.rst docs/usage/performance.rst kallithea/lib/paster_commands/template.ini.mako
diffstat 4 files changed, 4 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/docs/setup.rst	Mon Jun 08 14:10:13 2020 +0200
+++ b/docs/setup.rst	Mon Jun 08 16:05:21 2020 +0200
@@ -24,7 +24,7 @@
 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
--- a/docs/upgrade.rst	Mon Jun 08 14:10:13 2020 +0200
+++ b/docs/upgrade.rst	Mon Jun 08 16:05:21 2020 +0200
@@ -51,7 +51,7 @@
 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
--- a/docs/usage/performance.rst	Mon Jun 08 14:10:13 2020 +0200
+++ b/docs/usage/performance.rst	Mon Jun 08 16:05:21 2020 +0200
@@ -40,7 +40,7 @@
 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.
 
--- a/kallithea/lib/paster_commands/template.ini.mako	Mon Jun 08 14:10:13 2020 +0200
+++ b/kallithea/lib/paster_commands/template.ini.mako	Mon Jun 08 16:05:21 2020 +0200
@@ -463,6 +463,7 @@
 %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