Merge branch 'master' into almet/fix-supervisord-template

CHANGELOG.rst

@@ -6,9 +6,17 @@ This document describes changes between each past release.
 2.1.1 (unreleased)
 ------------------
 
+Fixed
+=====
+
 - Regenerate translations (#338)
 - Fix the supervisord template (#309)
+- Fix broken install with pip ≥ 10 (#340)
 
+Added
+=====
+
+- Document MySQL setup (#357)
 
 2.1 (2018-02-16)
 ----------------

Dockerfile

@@ -1,6 +1,7 @@
 FROM python:3.6-alpine
 
-RUN mkdir /ihatemoney &&\
+RUN apk add gcc libc-dev libffi-dev openssl-dev &&\
+    mkdir /ihatemoney &&\
     mkdir -p /etc/ihatemoney &&\
     pip install --no-cache-dir gunicorn pymysql
 

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.                                             |