Installation — I hate money 5.0 documentation (2024)

Requirements¶

«Ihatemoney» depends on:

• Python: any version from 3.7 to 3.12 will work.

• A database backend: choose among SQLite, PostgreSQL, MariaDB (>=10.3.2).

• Virtual environment (recommended): [python3-venv]{.title-ref}package under Debian/Ubuntu.

We recommend using virtualenvironments to isolatethe installation from other softwares on your machine, but it’s notmandatory.

If wondering about the backend, SQLite is the simplest and will workfine for most small to medium setups.

Prepare virtual environment (recommended)¶

Choose an installation path, here the current user’s home directory(~).

Create a virtual environment:

python3 -m venv ~/ihatemoneycd ~/ihatemoney

Activate the virtual environment:

source bin/activate

Install¶

Install the latest release with pip:

pip install ihatemoney

Test it¶

Once installed, you can start a test server:

ihatemoney generate-config ihatemoney.cfg > ihatemoney.cfgexport IHATEMONEY_SETTINGS_FILE_PATH=$PWD/ihatemoney.cfg ihatemoney db upgrade headihatemoney runserver

And point your browser at http://localhost:5000.

Generate your configuration¶

1. Initialize the ihatemoney directories:

   mkdir /etc/ihatemoney /var/lib/ihatemoney

2. Generate settings:

   ihatemoney generate-config ihatemoney.cfg > /etc/ihatemoney/ihatemoney.cfgchmod 740 /etc/ihatemoney/ihatemoney.cfg

You probably want to adjust /etc/ihatemoney/ihatemoney.cfg contents,you may do it later, see Configuration.

Configure database with MariaDB (optional)¶

1. Install PyMySQL dependencies. On Debian or Ubuntu, that would be:

   apt install python3-dev libssl-dev

2. Install PyMySQL (within your virtual environment):

   pip install 'PyMySQL>=0.9,<1.1'

3. Create an empty database and a database user

4. ConfigureSQLALCHEMY_DATABASE_URI accordingly

Configure database with PostgreSQL (optional)¶

1. Install python driver for PostgreSQL (from within your virtualenvironment):

   pip install psycopg2

2. Create the users and tables. On the command line, this looks like:

   sudo -u postgres psqlpostgres=# create database mydb;postgres=# create user myuser with encrypted password 'mypass';postgres=# grant all privileges on database mydb to myuser;

3. ConfigureSQLALCHEMY_DATABASE_URI accordingly.

Configure a reverse proxy¶

When deploying this service in production, you want to have a reverseproxy in front of the python application.

Here are documented two stacks. You can of course use another one if youwant. Don’t hesitate to contribute a small tutorial here if you want.

1. Apache and mod_wsgi

2. Nginx, Gunicorn and Supervisord/Systemd

With Apache and mod_wsgi¶

1. Fix permissions (considering www-data is the user running apache):

   chgrp www-data /etc/ihatemoney/ihatemoney.cfgchown www-data /var/lib/ihatemoney

2. Install Apache and mod_wsgi : libapache2-mod-wsgi(-py3) for Debianbased and mod_wsgi for RedHat based distributions

3. Create an Apache virtual host, the commandihatemoney generate-config apache-vhost.conf will output a goodstarting point (read and adapt it).

4. Activate the virtual host if needed and restart Apache

With Nginx, Gunicorn and Supervisord/systemd¶

Install Gunicorn:

pip install gunicorn

1. Create a dedicated unix user (here called ihatemoney),required dirs, and fix permissions:

   useradd ihatemoneychown ihatemoney /var/lib/ihatemoney/chgrp ihatemoney /etc/ihatemoney/ihatemoney.cfg

2. Create gunicorn config file :

   ihatemoney generate-config gunicorn.conf.py > /etc/ihatemoney/gunicorn.conf.py

3. Setup Supervisord or systemd

   • To use Supervisord, create supervisor config file :

     ihatemoney generate-config supervisord.conf > /etc/supervisor/conf.d/ihatemoney.conf

   • To use systemd services, create ihatemoney.service in /etc/systemd/system/ihatemoney.service [1]:

     [Unit]Description=I hate moneyRequires=network.target postgresql.serviceAfter=network.target postgresql.service[Service]Type=simpleUser=ihatemoneyExecStart=%h/ihatemoney/bin/gunicorn -c /etc/ihatemoney/gunicorn.conf.py ihatemoney.wsgi:applicationSyslogIdentifier=ihatemoney[Install]WantedBy=multi-user.target

     Obviously, adapt the ExecStart path for your installationfolder.

     If you use SQLite as database: remove mentions ofpostgresql.service in ihatemoney.service. If you use MariaDBas database: replace mentions of postgresql.service bymariadb.service in ihatemoney.service.

     Then reload systemd, enable and start ihatemoney:

     systemctl daemon-reloadsystemctl enable ihatemoney.servicesystemctl start ihatemoney.service

4. Copy (and adapt) output of ihatemoney generate-config nginx.confwith your nginx vhosts[2]

5. Reload nginx (and supervisord if you use it). It should be working;)