~stacyharper/fossbill

An open-source tool to bill your clients

ac8ee90 Fix reference to quote in generated pdfs

a month ago

a9437f4 Add a ~ before username to distinguish it

a month ago

#FossBill

#Development

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

#Deployment

Flask recommend to use wheel.

make build # build a .whl in dist/

Move this to a dedicated folder in your server.

rsync -a dist/ user@host:/var/www/fossbill/dist/

Connect to this server and go into the directory.

The first time, you should prepare dependencies like this:

python3 -venv venv
./venv/bin/pip3 install dist/fossbill-0.1.0-py3-none-any.whl # adapt using the builded version
./venv/bin/pip3 install waitress
./venv/bin/pip3 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.

You could then setup the system daemon and a proxy using say 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/fossbill-devel@lists.sr.ht'