FamilyTools

Deprecation notice:

This project will not be developed any further. Any use is strongly discouraged.

About

This web project is intended to provide a collection of useful tools on topics related to a family or shared household. At present, only a household book is included, which can be used to record and categorize income and expenditure.

This project is still in the early stages of development and there is probably only one running installation out there... which is mine. Nevertheless, I take the project seriously and try to make it the best tool for managing our household.

Setup dev environment

1. setup Python

Use a system-wide interpreter or create a virtual environment

2. provide a secret key

Django requires a secret key to work. It's not recommended to hard-code it into the project's settings.py file. Instead, it should be provided either as an environment variable called SECRET_KEY or in a separate file called .secret_key.txt within the project's root directory:

echo '<my-secret-key>' > .secret_key.txt

3. install requirements

pip install -r requirements.txt

4. generate static files

./manage.py collectstatic

5. initialize database

./manage.py migrate

6. create admin account

./manage.py createsuperuser

7. start web server

./manage.py runserver 8000

Run as container

Warning: This should only be started within a trusted and secure environment. Expect that this container is not safe and will likely have security issues which could be exploited by an attacker.

pull image

docker pull docker.pkg.github.com/cupracer/family-tools/family-tools:latest

run basic container for non-productive environment

Attention: Please note that you'll lose your database if the container is destroyed (see below for persistent storage)!

Replace <my-secret> with a real secret key.

docker run -it -e SECRET_KEY='<my-secret>' docker.pkg.github.com/cupracer/family-tools/family-tools:latest

limit allowed hosts by adding a container env variable

-e ALLOWED_HOSTS="['some.host.name', 'some.ip']"

use persistent database file

-v /path/to/persistent/db.sqlite3:/opt/family-tools/db.sqlite3

create super-user

docker exec -it my-container ./manage.py createsuperuser

Manage users

Login to the admin interface as superuser

http://<your-application>:8000/admin/

and create one or more users.

Make sure to add them to the group "members" to enable them for this application.