fossbill 1.11.0

A simple billing tool

FossBill

The code source behind fossbill.org.

Development

make instance/config.toml # Prepare the config, you may edit it
make venv-dev # Will prepare and install dependencies in venv
venv/bin/flask --app fossbill db upgrade head # Prepare and migrate the database
make run # Run the server

Production

python -m venv venv
venv/bin/python3 -m pip install fossbill waitress
venv/bin/python3 -m pip install psycopg2-binary # if you use postgres

Configure the instance

mkdir -p venv/var/fossbill-instance/
curl -o venv/var/fossbill-instance/config.toml https://git.sr.ht/~stacyharper/fossbill/blob/main/config.example.toml

Then edit this config.toml and setup the secret and database string.

Then migrate using:

venv/bin/flask --app fossbill db upgrade head

Running the server is as simple as:

venv/bin/flask --app fossbill run
# or
venv/bin/waitress-serve --listen=127.0.0.1:5554 --call 'fossbill:create_app'

But you should rather setup a system daemon, and a proxy using nginx. Have a look at the contrib/ folder.

Contribute

Send patches to the mailing list: Development mailing list.

To learn how to use git send-email, please see git-send-email.io.

git config format.subjectPrefix 'PATCH fossbill'
git config sendemail.to '~stacyharper/[e-mail]'