almet/ihatemoney
1
0
Fork 0
mirror of https://github.com/spiral-project/ihatemoney.git synced 2025-05-05 20:51:49 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adress @zorun feedback.

Browse source
This commit is contained in:
Alexis Métaireau 2021-10-20 23:42:23 +02:00
parent 7372aeaf26
commit 01415ab93d
3 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.rst
View file

@ -22,7 +22,7 @@ I hate money
It keeps track of who bought what, when, and for whom; and helps to settle the It keeps track of who bought what, when, and for whom; and helps to settle the
bills. bills.
* `Online documentation <https://ihatemoney.readthedocs.org>`_ * `Online documentation <https://ihatemoney.readthedocs.io>`_
* `Hosted version <https://ihatemoney.org>`_ * `Hosted version <https://ihatemoney.org>`_
* `Mailing list <https://mailman.alwaysdata.com/postorius/lists/info.ihatemoney.org/>`_ * `Mailing list <https://mailman.alwaysdata.com/postorius/lists/info.ihatemoney.org/>`_
(to get updates when needed). (to get updates when needed).

7
docs/contributing.rst
View file

@ -82,6 +82,13 @@ And then run the application::
cd ihatemoney cd ihatemoney
python run.py 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 Accessing dev server
-------------------- --------------------

10
docs/installation.rst
View file

@ -19,7 +19,7 @@ There are multiple ways to install «Ihatemoney» on your system :
With Docker With Docker
=========== ===========
Docker images are published `on the Docker hub <https://hub.docker.com/repository/docker/ihatemoney/ihatemoney>`_. Docker images are published `on the Docker hub <https://hub.docker.com/r/ihatemoney/ihatemoney/>`_.
This is probably the simplest way to get something running. Once you have Docker installed This is probably the simplest way to get something running. Once you have Docker installed
on your system, just issue :: on your system, just issue ::
@ -28,13 +28,13 @@ on your system, just issue ::
Ihatemoney is now available on http://localhost:8000. Ihatemoney is now available on http://localhost:8000.
All Ihatemoney settings can be passed with ``-e`` parameters All :ref:`settings<configuration>` can be passed with ``-e`` parameters
e.g. with a secure ``SECRET_KEY``, an external mail server and an e.g. with a secure ``SECRET_KEY``, an external mail server and an
external database:: external database::
docker run -d -p 8000:8000 \ docker run -d -p 8000:8000 \
-e SECRET_KEY="supersecure" \ -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_SERVER=smtp.gmail.com \
-e MAIL_PORT=465 \ -e MAIL_PORT=465 \
-e MAIL_USERNAME=your-email@gmail.com \ -e MAIL_USERNAME=your-email@gmail.com \
@ -42,6 +42,9 @@ external database::
-e MAIL_USE_SSL=True \ -e MAIL_USE_SSL=True \
ihatemoney/ihatemoney 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:: 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 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 <http://localhost:5000>`_.
Generate your configuration Generate your configuration
--------------------------- ---------------------------
You need to generate
1. Initialize the ihatemoney directories:: 1. Initialize the ihatemoney directories::
mkdir /etc/ihatemoney /var/lib/ihatemoney mkdir /etc/ihatemoney /var/lib/ihatemoney