mirror of
https://github.com/spiral-project/ihatemoney.git
synced 2025-04-29 01:42:37 +02:00
Document MySQL setup (#357)
PyMySQL is more difficult to install since its version 0.9 since it now depends on *cryptography* lib, which in turns depends on OpenSSL and Python dev files. See https://github.com/PyMySQL/PyMySQL/issues/697
This commit is contained in:
parent
026c1ec4aa
commit
9caf213e1d
2 changed files with 24 additions and 1 deletions
|
@ -12,6 +12,11 @@ Fixed
|
||||||
- Regenerate translations (#338)
|
- Regenerate translations (#338)
|
||||||
- Fix broken install with pip ≥ 10 (#340)
|
- Fix broken install with pip ≥ 10 (#340)
|
||||||
|
|
||||||
|
Added
|
||||||
|
=====
|
||||||
|
|
||||||
|
- Document MySQL setup (#357)
|
||||||
|
|
||||||
|
|
||||||
2.1 (2018-02-16)
|
2.1 (2018-02-16)
|
||||||
----------------
|
----------------
|
||||||
|
|
|
@ -63,6 +63,22 @@ Once installed, you can start a test server::
|
||||||
|
|
||||||
And point your browser at `http://localhost:5000 <http://localhost:5000>`_.
|
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
|
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
|
docker run -d -p 8000:8000 ihatemoney -w 3
|
||||||
|
|
||||||
|
.. _configuration:
|
||||||
|
|
||||||
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 |
|
| | | **Production value:** `ihatemoney conf-example ihatemoney.cfg` sets it to something |
|
||||||
| | | random, which is good. |
|
| | | 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. |
|
| | "budget@notmyidea.org")`` | emails. |
|
||||||
| | | |
|
| | | |
|
||||||
| | | **Production value:** Any tuple you want. |
|
| | | **Production value:** Any tuple you want. |
|
||||||
|
|
Loading…
Reference in a new issue