From 01415ab93defddba26b67c8371dc43e81a9541f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Wed, 20 Oct 2021 23:42:23 +0200 Subject: [PATCH] Adress @zorun feedback. --- README.rst | 2 +- docs/contributing.rst | 7 +++++++ docs/installation.rst | 10 ++++++---- 3 files changed, 14 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a3e4e7f3..e1c63a01 100644 --- a/README.rst +++ b/README.rst @@ -22,7 +22,7 @@ I hate money It keeps track of who bought what, when, and for whom; and helps to settle the bills. -* `Online documentation `_ +* `Online documentation `_ * `Hosted version `_ * `Mailing list `_ (to get updates when needed). diff --git a/docs/contributing.rst b/docs/contributing.rst index 3006fa96..1bdb94fa 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -82,6 +82,13 @@ And then run the application:: cd ihatemoney python run.py +The docker way +-------------- + +If you prefer to use docker, then you can build your image with:: + + docker build -t ihatemoney . + Accessing dev server -------------------- diff --git a/docs/installation.rst b/docs/installation.rst index 86c79c47..9355ce9a 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -19,7 +19,7 @@ There are multiple ways to install «Ihatemoney» on your system : With Docker =========== -Docker images are published `on the Docker hub `_. +Docker images are published `on the Docker hub `_. This is probably the simplest way to get something running. Once you have Docker installed on your system, just issue :: @@ -28,13 +28,13 @@ on your system, just issue :: Ihatemoney is now available on http://localhost:8000. -All Ihatemoney settings can be passed with ``-e`` parameters +All :ref:`settings` can be passed with ``-e`` parameters e.g. with a secure ``SECRET_KEY``, an external mail server and an external database:: docker run -d -p 8000:8000 \ -e SECRET_KEY="supersecure" \ - -e SQLALCHEMY_DATABASE_URI="mysql+pymysql://user:pass@172.17.0.5/ihm" \ + -e SQLALCHEMY_DATABASE_URI="mysql+pymysql://user:pass@78.198.38.17/ihm" \ -e MAIL_SERVER=smtp.gmail.com \ -e MAIL_PORT=465 \ -e MAIL_USERNAME=your-email@gmail.com \ @@ -42,6 +42,9 @@ external database:: -e MAIL_USE_SSL=True \ ihatemoney/ihatemoney +.. note: Connecting to a postgresql database is not supported for now in the + docker container. + A volume can also be specified to persist the default database file:: docker run -d -p 8000:8000 -v /host/path/to/database:/database ihatemoney/ihatemoney @@ -128,7 +131,6 @@ And point your browser at `http://localhost:5000 `_. Generate your configuration --------------------------- -You need to generate 1. Initialize the ihatemoney directories:: mkdir /etc/ihatemoney /var/lib/ihatemoney