Improved dockerfile, config file usage and documentation

2015-05-16 00:56:09 +02:00
parent 2a6b1b7b56
commit 62b5d1c6eb
10 changed files with 222 additions and 63 deletions
--- a/doc/admin/config.rst
+++ b/doc/admin/config.rst
@@ -0,0 +1,153 @@
+.. highlight:: ini
+
+Configuration file
+==================
+
+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.
+
+1. ``/etc/pretix/pretix.cfg``
+2. ``~/.pretix.cfg``
+3. ``pretix.cfg`` in 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).
+
+pretix settings
+---------------
+
+Example::
+
+    [pretix]
+    instance_name=pretix.de
+    global_registration=off
+    site_url=http://localhost
+    currency=EUR
+
+``instance_name``
+    The name of this installation. Default: ``pretix.de``
+
+``global_registration``
+    Whether or not this installation supports global user accounts (in addition to
+    event-bound accounts). Defaults to ``True``.
+
+``site_url``
+    The installation's full URL, without a trailing slash.
+
+``currency``
+    The default currency as a three-letter code. Defaults to ``EUR``.
+
+Locale settings
+---------------
+
+Example::
+
+    [locale]
+    default=de
+    timezone=Europe/Berlin
+
+``default``
+    The system's default locale. Default: ``en``
+
+``timezone``
+    The system's default timezone as a ``pytz`` name. Default: ``UTC``
+
+Database settings
+-----------------
+
+Example::
+
+    [database]
+    backend=mysql
+    name=pretix
+    user=pretix
+    password=abcd
+    host=localhost
+    port=3306
+
+``backend``
+    One of ``mysql``, ``sqlite3``, ``oracle`` and ``postgresql_psycopg2``.
+    Default: ``sqlite3``.
+
+``name``
+    The database's name. Default: ``db.sqlite3``.
+
+``user``, ``password``, ``host``, ``port``
+    Connection details for the database connection. Empty by default.
+
+Uploaded files
+--------------
+
+Example::
+
+    [media]
+    url=/media/
+    root=media
+
+``root``
+    The filesystem location to store user-uploaded content at. By default, this takes
+    the value of the environment variable ``MEDIA_ROOT``, if present, or ``media`` if not.
+
+``url``
+    The URL to be used to serve user-uploaded content. You should not need to modify
+    this. Default: ``/media/``
+
+Email
+-----
+
+Example::
+
+    [mail]
+    from=hello@localhost
+
+``from``
+    The email address to set as ``From`` header in outgoing emails by the system.
+    Default: ``pretix@localhost``
+
+Django settings
+---------------
+
+Example::
+
+    [django]
+    hosts=localhost
+    secret=j1kjps5a5&4ilpn912s7a1!e2h!duz^i3&idu@_907s$wrz@x-
+    debug=off
+
+``hosts``
+    Comma-seperated list of allowed host names for this installation.
+    Default: ``localhost``
+
+``secret``
+    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 store it in the filesystem for later usage.
+
+``debug``
+    Whether or not to run in debug mode. Default is ``False``.
+
+    .. WARNING:: Never set this to ``True`` in production!
+
+Static files
+------------
+
+You should *not* need to modify these settings as logn as you don't want to use a
+custom delivery method for static files such as an external CDN.
+
+Example::
+
+    [static]
+    url=/static/
+    root=_static
+
+``url``
+    The URL to be used to serve static files. Default: ``/static/``.
+
+``root``
+    The filesystem path to be used for static file storage. Default: ``_static``
+
+
+.. _Python documentation: https://docs.python.org/3/library/configparser.html?highlight=configparser#supported-ini-file-structure