aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorAlexis Metaireau <alexis@notmyidea.org>2019-01-16 13:13:04 +0100
committerGitHub <noreply@github.com>2019-01-16 13:13:04 +0100
commitbbf832bec70d4583f9141af5c0efce0ddb7e0c17 (patch)
tree3cb0146dcbb506b1a7499715923026609f2abb4d /docs
parentd55b9961704f913312ae17f837f62d1822802ecf (diff)
downloadihatemoney-mirror-bbf832bec70d4583f9141af5c0efce0ddb7e0c17.zip
ihatemoney-mirror-bbf832bec70d4583f9141af5c0efce0ddb7e0c17.tar.gz
ihatemoney-mirror-bbf832bec70d4583f9141af5c0efce0ddb7e0c17.tar.bz2
Document PostgreSQL configuration. Fixes #403 (#415)
* Document PostgreSQL configuration. Fixes #403
Diffstat (limited to 'docs')
-rw-r--r--docs/installation.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/installation.rst b/docs/installation.rst
index 38374e9..11a6db6 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -66,7 +66,7 @@ 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.
+.. note:: Only required if you use MySQL/MariaDB.
1. Install PyMySQL dependencies. On Debian or Ubuntu, that would be::
@@ -79,6 +79,19 @@ Only required if you prefer MySQL/MariaDB over SQLite.
3. Create an empty database and a database user
4. Configure :ref:`SQLALCHEMY_DATABASE_URI <configuration>` accordingly
+
+Configure database with PostgreSQL (optional)
+=============================================
+
+.. note:: Only required if you use Postgresql.
+
+1. Install python driver for PostgreSQL (from within your virtualenv)::
+
+ pip install psycopg2
+
+2. Configure :ref:`SQLALCHEMY_DATABASE_URI <configuration>` accordingly
+
+
Deploy it
=========
@@ -200,6 +213,10 @@ format used can be found on `the SQLAlchemy documentation`_.
``sqlite:///home/ihatemoney/ihatemoney.db``. Do *not* store it under
``/tmp`` as this folder is cleared at each boot.
+If you're using PostgreSQL, Your client must use utf8. Unfortunately, PostgreSQL default
+is to use ASCII. Either change your client settings, or specify the encoding by appending
+`?client_encoding=utf8` to the connection string.
+
`SECRET_KEY`
------------