Pretix reads its configuration from a configuration file. It tries to find this file at the following locations. It will try to read the file from the specified paths in the following order. The file that is found last will override the settings from the files found before.
pretix.cfgin the current working directory
The file is expected to be in the INI format as specified in the Python documentation.
The config file may contain the following sections (all settings are optional and have default values). We suggest that you start from the examples given in one of the installation tutorials.
The configuration file is the recommended way to configure pretix. However, you can
also set them through environment variables. In this case, the syntax is
PRETIX_SECTION_CONFIG. For example, to configure the setting
[pretix] section, set
PRETIX_PRETIX_PASSWORD_RESET=off in your
[pretix] instance_name=pretix.de url=http://localhost currency=EUR datadir=/data plugins_default=pretix.plugins.sendmail,pretix.plugins.statistics cookie_domain=.pretix.de
The name of this installation. Default:
The installation’s full URL, without a trailing slash.
The default currency as a three-letter code. Defaults to
The local path to a data directory that will be used for storing user uploads and similar data. Defaults to the value of the environment variable
A comma-separated list of plugins that are enabled by default for all new events. Defaults to
A comma-separated list of plugins that are not available even though they are installed. Defaults to an empty string.
A comma-separated list of available auth backends. Defaults to
The cookie domain to be set. Defaults to
Enables or disables the registration of new admin users. Defaults to
Enables or disables password reset. Defaults to
Enables or disables the “keep me logged in” button. Defaults to
By default, pretix periodically downloads a XML file from the European Central Bank to retrieve exchange rates that are used to print tax amounts in the customer currency on invoices for some currencies. Set to
offto disable this feature. Defaults to
Enables or disables nagging staff users for leaving comments on their sessions for auditability. Defaults to
Enables or disables obligatory usage of Two-Factor Authentication for users of the pretix backend. Defaults to
Specifies whether the
X-Forwarded-Forheader can be trusted. Only set to
onif you have a reverse proxy that actively removes and re-adds the header to make sure the correct client IP is the first value. Defaults to
Specifies whether the
X-Forwarded-Protoheader can be trusted. Only set to
onif you have a reverse proxy that actively removes and re-adds the header to make sure the correct value is set. Defaults to
Log violations of the Content Security Policy (CSP). Defaults to
Set console and file log level (
CRITICAL). Defaults to
[locale] default=de timezone=Europe/Berlin
The system’s default locale. Default:
The system’s default timezone as a
[database] backend=mysql name=pretix user=pretix password=abcd host=localhost port=3306
If you use MySQL, be sure to create your database using
CREATE DATABASE <dbname> CHARACTER SET utf8;. Otherwise, Unicode support will not properly work.
The database’s name. Default:
Connection details for the database connection. Empty by default.
Indicates if the database backend is a MySQL/MariaDB Galera cluster and turns on some optimizations/special case handlers. Default:
Database replica settings¶
If you use a replicated database setup, pretix expects that the default database connection always points to the primary database node. Routing read queries to a replica on database layer is strongly discouraged since this can lead to inaccurate such as more tickets being sold than are actually available.
However, pretix can still make use of a database replica to keep some expensive queries with that can tolerate some latency from your
primary database, such as backend search queries. The
replica configuration section can have the same settings as the
section (except for the
backend setting) and will default back to the
database settings for all values that are not given. This
way, you just need to specify the settings that are different for the replica.
[urls] media=/media/ static=/media/
The URL to be used to serve user-uploaded content. You should not need to modify this. Default:
The URL to be used to serve static files. You should not need to modify this. Default:
[mail] from=hello@localhost host=127.0.0.71 user=pretix password=foobar port=1025 tls=on ssl=off
The SMTP Host to connect to. Defaults to
The SMTP user data to use for the connection. Empty by default.
The email address to set as
Fromheader in outgoing emails by the system. Default:
Use STARTTLS or SSL for the SMTP connection. Off by default.
Comma-separated list of email addresses that should receive a report about every error code 500 thrown by pretix.
[django] secret=j1kjps5a5&4ilpn912s7a1!e2h!duz^i3&idu@_907s$wrz@x- debug=off
The secret to be used by Django for signing and verification purposes. If this setting is not provided, pretix will generate a random secret on the first start and will store it in the filesystem for later usage.
Whether or not to run in debug mode. Default is
Never set this to
Enable code profiling for a random subset of requests. Disabled by default, see Performance monitoring for details.
If you want to fetch internally collected prometheus-style metrics you need to configure the credentials for the metrics endpoint and enable it:
[metrics] enabled=true user=your_user passphrase=mysupersecretpassphrase
Currently, metrics-collection requires a redis server to be available.
You can use an existing memcached server as pretix’s caching backend:
The location of memcached, either a host:port combination or a socket file.
If no memcached is configured, pretix will use Django’s built-in local-memory caching method.
If you use memcached and you deploy pretix across multiple servers, you should use one shared memcached instance, not multiple ones, because cache invalidations would not be propagated otherwise.
If a redis server is configured, pretix can use it for locking, caching and session storage to speed up various operations:
[redis] location=redis://127.0.0.1:6379/1 sessions=false
The location of redis, as a URL of the form
When this is set to
True, redis will be used as the session storage.
If redis is not configured, pretix will store sessions and locks in the database. If memcached is configured, memcached will be used for caching instead of redis.
pretix comes with a number of translations. Some of them are marked as “incubating”, which means they can usually only be selected in development mode. If you want to use them nevertheless, you can activate them like this:
You can also tell pretix about additional paths where it will search for translations:
For a given language (e.g.
pt-br), pretix will then look in the
specific sub-folder, e.g.
Celery task queue¶
For processing long-running tasks asynchronously, pretix requires the celery task queue. For communication between the web server and the task workers in both direction, a messaging queue and a result backend is needed. You can use a redis database for both directions, or an AMQP server (e.g. RabbitMQ) as a broker and redis or your database as a result backend:
[celery] broker=amqp://guest:guest@localhost:5672// backend=redis://localhost/0
RabbitMQ might be the better choice if you have a complex, multi-server, high-performance setup, but as you already should have a redis instance ready for session and lock storage, we recommend redis for convenience. See the Celery documentation for more details.
pretix has native support for sentry, a tool that you can use to track errors in the application. If you want to use sentry, you need to set a DSN in the configuration file:
You will be given this value by your sentry installation.
You can adjust some caching settings to control how much storage pretix uses:
[cache] tickets=48 ; Number of hours tickets (PDF, passbook, …) are cached
If you are really paranoid, you can increase the length of random strings pretix uses in various places like order codes, secrets in the ticket QR codes, etc. Example:
[entropy] ; Order code needs to be < 16 characters, default is 5 order_code=5 ; Ticket secret needs to be < 64 characters, default is 32 ticket_secret=32 ; Voucher code needs to be < 255 characters, default is 16 voucher_code=16
pretix can make use of some external tools if they are installed. Currently, they are all optional. Example: