🦙 presign ✍️

singup software for alpaca and other fluffy animals

Configuration

Configuration is done using environment variables. See docker_env.example for an example.

Installation (Docker)

Manual Build

We provide a dockerfile for easy setup. To build it, run

docker build -f image/Dockerfile -t presign:latest .

Pull from GitHub

docker pull ghcr.io/alpakainfracrew/presign:main

Now copy docker_env.example to docker_env and change the settings. After that you can start the image by running

mkdir data_volume
docker run -it -p 8002:8000 --env-file docker_env --mount type=bind,source="$(pwd)"/data_volume,target=/app/data presign:latest

Now access http://localhost:8002/control with the superuser credentials specifies in docker_env

SystemD Unit (Run dockerized presign)

The file presign.service can be moved to /etc/systemd/system/ to start/stop the presign service via systemd. Please change the <presign directory> part to your presign location in the systemd file!

To activate the SystemD Unit run the following commands after placing the file into /etc/systemd/system/:

systemctl daemon-reload
systemctl enable presign.service
systemctl start presign.service

Installation (Manual/Development)

Make sure you have set the necessary configuration.

presign should run out of the box for development purposes.

For production usage, you want to set a proper DJANGO_SECRET_KEY and use a proper database instead of sqlite (e.g. postgres)

Install python and typescript (tsc). Then run

poetry install

to install the python dependencies.

Run migrations:

poetry run python manage.py migrate

Then run

poetry run python manage.py import_text_defaults mail_texts.json status_texts.json

to import the default texts for mails and status.

Then run

poetry run python manage.py createsuperuser

and follow the instructions to create a super user.

Then run

poetry run python manage.py runserver

to start the development server.

You can now go to http://localhost:8000/control and login.

Development

Test/Demo Data

You can load test/demo data using the following command:

poetry run python manage.py loaddata fixtures/example.yaml

User/Password: presignadm/presignadm

E-Mails

During development, sent emails are saved to the sent_email/ folder.

Offline Compression

If the sass/ts compilers run too long during development, you can switch to offline compression. To do so set the USE_OFFLINE_COMPRESSION_IN_DEV environment variable to True. You know have to pre-compile the compressor files by running

poetry run python manage.py compress

You might have to restart the development server after that.

License

Presign is published under an AGPLv3 license with the following exception:

The files presign/base/static/Server_says_no.gif and presign/base/static/Server_says_no.png are CC-BY-SA 4.0 lavalaempchen.

Parts of the code in this repository are taken from / based on other projects. Their licenses apply to the relevant parts of the code. The parts from other projects are:

• presign/static/vendored contains files vendored from other projects. They are licensed under the terms written in the LICENSE or LICENSE.md in the respective directory.
• Some files in presign/base/templates/mail/ are based on the Cerberus fluid template. These files contain a line marking them as such