pretix

pretix is an open source ticketing solution. It is written in Django and can be highly customized for the process of ticket sales.


Note

For this guide you should be familiar with the basic concepts of

License

pretix community edition is licenced under AGPL 3 with additional terms. See the license FAQ for details. The licence text can be found here.

Prerequisites

Note

Since release 2023.6.0 pretix no longer supports MySQL or MariaDB, instead PostgreSQL is required.

For setting up PostgreSQL follow this UberLab guide. As recommended in the Section Database and User Management please set up a user isabell_pretix and database isabell_pretix_db for this project.

Your URL needs to be setup:

[isabell@stardust ~]$ uberspace web domain list
isabell.uber.space
[isabell@stardust ~]$

Note

pretix uses Redis to manage background tasks, so you should install it using the default configuration.

Installation

Download & Install

Install pretix using the python package manager:

[isabell@stardust ~]$ pip3.11 install pretix gunicorn --user
[...]
 Running setup.py install for static3 ... done
 Running setup.py install for slimit ... done
 Running setup.py install for future ... done
 Running setup.py install for dj-static ... done
 Running setup.py install for vobject ... done
 Running setup.py install for python-u2flib-server ... done
 Running setup.py install for jwcrypto ... done
 Running setup.py install for django-jquery-js ... done
 Running setup.py install for paypalrestsdk ... done
 Running setup.py install for paypal-checkout-serversdk ... done
[...]
Successfully installed BeautifulSoup4-4.12.2 Django-3.2.19 Pillow-9.5.0 PyJWT-2.6.0 aiohttp-3.8.4 aiosignal-1.3.1 amqp-5.1.1 arabic-reshaper-3.0.0 asgiref-3.7.2 async-timeout-4.0.2 attrs-23.1.0 babel-2.12.1 billiard-3.6.4.0 bleach-5.0.1 cbor2-5.4.6 [...]
[isabell@stardust ~]$

Also, you need to create an extra data folder:

[isabell@stardust ~]$ mkdir ~/pretix_data
[isabell@stardust ~]$

Configuration

Now you need to set up the configuration, create the file ~/.pretix.cfg and insert the following content:

Warning

Be sure, to replace all values with correct data of your own Uberspace account!

  [pretix]
  instance_name=Isabells pretix
  url=https://isabell.uber.space
  currency=EUR
  datadir=/home/isabell/pretix_data
  trust_x_forwarded_proto=on

  [database]
  backend=postgresql
  name=isabell_pretix_db
  user=isabell_pretix
  password=MySuperSecretPassword
  host=localhost
  port=5432

  [celery]
  broker=redis+socket:///home/isabell/.redis/sock
  backend=redis+socket:///home/isabell/.redis/sock

  [mail]
  from=isabell@uber.space
  host=stardust.uberspace.de
  user=isabell@uber.space
  password=MySuperSecretPassword
  port=587
  tls=on

Initialize database

Initialize the pretix database tables and generate the static files:

[isabell@stardust ~]$ python3.11 -m pretix migrate
Operations to perform:
 Apply all migrations: auth, badges, banktransfer, contenttypes, oauth2_provider, otp_static, otp_totp, paypal, pretixapi, pretixbase, pretixdroid, pretixhelpers, pretixmultidomain, sendmail, sessions, stripe, ticketoutputpdf
 Running migrations:
   Applying contenttypes.0001_initial... OK
   Applying contenttypes.0002_remove_content_type_name... OK
   Applying auth.0001_initial... OK
   Applying auth.0002_alter_permission_name_max_length... OK
   Applying auth.0003_alter_user_email_max_length... OK
   Applying auth.0004_alter_user_username_opts... OK
   Applying auth.0005_alter_user_last_login_null... OK
[...]

Preparing static files

[isabell@stardust ~]$ python3.11 -m pretix rebuild
[...]
File “/home/isabell/.local/lib/python3.11/site-packages/django/contrib/sites/locale/be/LC_MESSAGES/django.po” is already compiled and up to date.
File “/home/isabell/.local/lib/python3.11/site-packages/django/contrib/sites/locale/id/LC_MESSAGES/django.po” is already compiled and up to date.
File “/home/isabell/.local/lib/python3.11/site-packages/django/contrib/sites/locale/it/LC_MESSAGES/django.po” is already compiled and up to date.
processing file django.po in /home/isabell/.local/lib/python3.11/site-packages/django/contrib/sites/locale/sl/LC_MESSAGES
processing language es
processing language tr
processing language uk

954 static files copied to '/home/isabell/.local/lib/python3.11/site-packages/pretix/static.dist', 970 post-processed.
Compressing... done
Compressed 28 block(s) from 547 template(s) for 1 context(s).
[isabell@stardust ~]$

pretix doesn’t serve static files by itself. We can use apache to do that for us, but we first need to move the static files into the uberspace document root.

[isabell@stardust ~]$ cp -r ~/.local/lib/python3.11/site-packages/pretix/static.dist /var/www/virtual/isabell/html/static
[isabell@stardust ~]$

Service

Next, you should set up a service that keeps pretix alive while you are gone. Therefor create the file ~/etc/services.d/pretix.ini with the following content:

[program:pretix]
command=gunicorn --reload --preload --bind 0.0.0.0:9000 --workers 2 pretix.wsgi --name pretix --max-requests 1200 --max-requests-jitter 50
directory=%(ENV_HOME)s/pretix_data
autostart=true
autorestart=true
stopsignal=INT

[program:pretix_worker]
command=celery -A pretix.celery_app worker -l info --concurrency 1
directory=%(ENV_HOME)s/pretix_data
autostart=true
autorestart=true
stopsignal=INT

After creating the configuration, tell supervisord to refresh its configuration and start the service:

[isabell@stardust ~]$ supervisorctl reread
SERVICE: available
[isabell@stardust ~]$ supervisorctl update
SERVICE: added process group
[isabell@stardust ~]$ supervisorctl status
SERVICE                            RUNNING   pid 26020, uptime 0:03:14
[isabell@stardust ~]$

If the two services are not in state RUNNING, check your configuration.

Web Backend

Note

pretix should now be running on port 9000.

To make the application accessible from the outside, configure a web backend:

[isabell@stardust ~]$ uberspace web backend set / --http --port <port>
Set backend for / to port <port>; please make sure something is listening!
You can always check the status of your backend using "uberspace web backend list".
[isabell@stardust ~]$

Paths under /static/ and /media/ need to be served by apache:

[isabell@stardust ~]$ uberspace web backend set /static --apache
Set backend for /static to apache.
[isabell@stardust ~]$ uberspace web backend set /media --apache
Set backend for /media to apache.
[isabell@stardust ~]$

Cronjob

Create a new cronjob using crontab -e:

18,48 * * * * cd ~/pretix_data && python3.11 -m pretix runperiodic

Media files

Media files are files uploaded by users or generated by the application. This includes product images or custom favicons you can upload directly inside pretix. The files are stored inside the configured data directory /home/isabell/pretix_data/media/. Like static files, pretix does not serve some media files by itself. To serve the files, (regularly) move the folders relevant to you to the web root we configured to be served by apache, e.g.:

[isabell@stardust ~]$ rsync --recursive --times --delete ~/pretix_data/media/pub /var/www/virtual/isabell/html/media
[isabell@stardust ~]$

Accessing pretix

Now point your Browser to your installation URL https://isabell.uber.space. You will find the administration panel at https://isabell.uber.space/control/.

Use admin@localhost as username and admin as password for your first login. You should change this password immediately after login!

Updates

Note

Check the update feed regularly to stay informed about the newest version.

If there is a new version available, install the new version like so:

[isabell@stardust ~]$ pip3.11 install pretix==2024.1.0 --user
[isabell@stardust ~]$

Then re-run the Initialize database steps and restart the service like so:

[isabell@stardust ~]$ python3.11 -m pretix migrate
[isabell@stardust ~]$ python3.11 -m pretix rebuild
[isabell@stardust ~]$ python3.11 -m pretix updateassets
[usabell@stardust ~]$ cp -r ~/.local/lib/python3.11/site-packages/pretix/static.dist /var/www/virtual/isabell/html/static
[isabell@stardust ~]$ supervisorctl restart pretix
[isabell@stardust ~]$

Tested with pretix 2023.10.0 and Uberspace 7.15.9

Written by: ezra <ezra@posteo.de>, luto <m@luto.at>, chriskbach <https://github.com/chriskbach/>, qbit <chaos.social/@qbit>

This guide was written with the help of a former text on “bullshit_”, thanks to Nathan.