aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexis Métaireau <alexis@vieuxsinge.com>2018-08-05 14:27:30 +0200
committerAlexis Métaireau <alexis@vieuxsinge.com>2018-08-05 14:27:30 +0200
commit08bcf702b86d520b15cd8e9acee3b8df1fe9d07b (patch)
tree3efe64ac82b2314183044e604ddb563818c6bf70 /docs
parent9ece687eb04959267c212da9e5abc288e7e4b84d (diff)
parent94e2befb8290053e1159925e782a17a2dfb19e20 (diff)
downloadihatemoney-mirror-08bcf702b86d520b15cd8e9acee3b8df1fe9d07b.zip
ihatemoney-mirror-08bcf702b86d520b15cd8e9acee3b8df1fe9d07b.tar.gz
ihatemoney-mirror-08bcf702b86d520b15cd8e9acee3b8df1fe9d07b.tar.bz2
Merge branch 'master' into almet/fix-supervisord-template
Diffstat (limited to 'docs')
-rw-r--r--docs/installation.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index e7d586e..4829c5d 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -63,6 +63,22 @@ Once installed, you can start a test server::
And point your browser at `http://localhost:5000 <http://localhost:5000>`_.
+Configure database with MySQL/MariaDB (optional)
+================================================
+
+Only required if you prefer MySQL/MariaDB over SQLite.
+
+1. Install PyMySQL dependencies. On Debian or Ubuntu, that would be::
+
+ apt install python3-dev libssl-dev
+
+2. Install PyMySQL (within your virtualenv)::
+
+ pip install 'PyMySQL>=0.9,<0.10'
+
+3. Create an empty database and a database user
+4. Configure :ref:`SQLALCHEMY_DATABASE_URI <configuration>` accordingly
+
Deploy it
=========
@@ -159,6 +175,8 @@ For example, use the following command to add more gunicorn workers::
docker run -d -p 8000:8000 ihatemoney -w 3
+.. _configuration:
+
Configuration
=============
@@ -187,7 +205,7 @@ Production values are recommended values for use in production.
| | | **Production value:** `ihatemoney conf-example ihatemoney.cfg` sets it to something |
| | | random, which is good. |
+-------------------------------+---------------------------------+----------------------------------------------------------------------------------------+
-| MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email address to use when sending |
+| MAIL_DEFAULT_SENDER | ``("Budget manager", | A python tuple describing the name and email address to use when sending |
| | "budget@notmyidea.org")`` | emails. |
| | | |
| | | **Production value:** Any tuple you want. |