CGM_Public/pretix_original
2
0
Fork 1
mirror of https://github.com/pretix/pretix.git synced 2026-08-07 10:17:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed minor documentation errors and mistakes (#151)

Browse Source
This commit is contained in:
Tobias Kunze
2016-07-14 20:01:38 +02:00
committed by Raphael Michel
parent f779b70deb
commit bfc721978d
41 changed files with 231 additions and 208 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/admin/config.rst
+11 -11
View File
@@ -147,7 +147,7 @@ Example::
Use STARTTLS or SSL for the SMTP connection. Off by default.
``admins``
Comma-separated list of e-mail addresses that should receive a report about every error 500 thrown by pretix.
Comma-separated list of email addresses that should receive a report about every error code 500 thrown by pretix.
Django settings
---------------
@@ -160,13 +160,13 @@ Example::
debug=off
``hosts``
Comma-seperated list of allowed host names for this installation.
Comma-separated 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.
and will store it in the filesystem for later usage.
``debug``
Whether or not to run in debug mode. Default is ``False``.
@@ -185,7 +185,7 @@ You can use an existing memcached server as pretix's caching backend::
``location``
The location of memcached, either a host:port combination or a socket file.
If no memcached is configures, pretix will use Django's built-in local-memory caching method.
If no memcached is configured, pretix will use Django's built-in local-memory caching method.
Redis
@@ -199,22 +199,22 @@ to speed up various operations::
sessions=false
``location``
The location of memcached, as an URL of the form ``redis://[:password]@localhost:6379/0``
The location of redis, as a URL of the form ``redis://[:password]@localhost:6379/0``
or ``unix://[:password]@/path/to/socket.sock?db=0``
``session``
When this is set to true, redis will be used as the session storage.
When this is set to ``True``, redis will be used as the session storage.
If no redis is configured, pretix will store sessions and locks in the database. If memcached
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.
Celery task queue
-----------------
For processing long-running tasks asynchronously, pretix needs help of the celery task queue.
For communicating between the web server and the task workers in both direction, a messaging
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.h. RabbitMQ) as a broker and redis or your database as a result backend::
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//
@@ -225,4 +225,4 @@ but as you already should have a redis instance ready for session and lock stora
redis for convenience. See the `Celery documentation`_ for more details.
.. _Python documentation: https://docs.python.org/3/library/configparser.html?highlight=configparser#supported-ini-file-structure
.. _Celery documentation: http://docs.celeryproject.org/en/latest/configuration.html
.. _Celery documentation: http://docs.celeryproject.org/en/latest/configuration.html
doc/admin/installation/docker_smallscale.rst
+13 -13
View File
@@ -18,8 +18,8 @@ modern distributions, especially on all systemd-based ones.
Requirements
------------
Please set up the following systems beforehand, we'll not explain them here (but link to installation guides
somewhere else):
Please set up the following systems beforehand, we'll not explain them here (but see these links for external
installation guides):
* `Docker`_
* A SMTP server to send out mails, e.g. `Postfix`_ on your machine or some third-party server you have credentials for
@@ -43,8 +43,8 @@ all lines prepended with a ``$`` symbol can also be run by an unprivileged user.
Data files
----------
First of all, you need a directory on your server that pretix can use to store data files and make that directory
writable to the user that runs pretix inside the docker container::
First of all, you need to create a directory on your server that pretix can use to store data files and make that
directory writable to the user that runs pretix inside the docker container::
# mkdir /var/pretix-data
# chown -R 15371:15371 /var/pretix-data
@@ -52,7 +52,7 @@ writable to the user that runs pretix inside the docker container::
Database
--------
Next, we need a database and a database user. We create this with any kind of database managing tool or directly on
Next, we need a database and a database user. We can create these with any kind of database managing tool or directly on
our database's shell, e.g. for MySQL::
$ mysql -u root -p
@@ -61,15 +61,15 @@ our database's shell, e.g. for MySQL::
mysql> FLUSH PRIVILEGES;
Replace the asterisks with a password of your own. For MySQL, we will use a unix domain socket to connect to the
database. For PostgreSQL, be sure to configure the interface binding and your firewall such that the docker container
database. For PostgreSQL, be sure to configure the interface binding and your firewall so that the docker container
can reach PostgreSQL.
Redis
-----
For caching and messaging in small-scale setups, pretix recomments using redis. In this small-scale setup we assume a
redis instance running on the same host. To avoid the hassle about network configurations and firewalls, we recommend
connecting to redis via an unix socket. To enable redis on unix sockets, add the following to your
For caching and messaging in small-scale setups, pretix recommends using redis. In this small-scale setup we assume a
redis instance to be running on the same host. To avoid the hassle with network configurations and firewalls, we
recommend connecting to redis via a unix socket. To enable redis on unix sockets, add the following to your
``/etc/redis/redis.conf``::
unixsocket /tmp/redis.sock
@@ -85,7 +85,7 @@ Now restart redis-server::
can easily become an even worse security hole when configured slightly wrong. Read more about security
on the `redis website`_.
Another possible solution is to run `redis in docker`_ and link the containers using dockers networking
Another possible solution is to run `redis in docker`_ and link the containers using docker's networking
features.
Config file
@@ -212,7 +212,7 @@ Next steps
----------
Yay, you are done! You should now be able to reach pretix at https://pretix.yourdomain.com/control/ and log in as
*admin@localhost* with a passwort of *admin*. Don't forget to change that password! Create an organizer first, then
*admin@localhost* with a password of *admin*. Don't forget to change that password! Create an organizer first, then
create an event and start selling tickets!
Updates
@@ -220,7 +220,7 @@ Updates
.. warning:: While we try hard not to break things, **please perform a backup before every upgrade**.
Updates are fairly simple, but require at least a small downtime::
Updates are fairly simple, but require at least a short downtime::
# docker pull pretix/standalone
# systemctl restart pretix.service
@@ -238,4 +238,4 @@ Restarting the service can take a few seconds, especially if the update requires
.. _ufw: https://en.wikipedia.org/wiki/Uncomplicated_Firewall
.. _redis website: http://redis.io/topics/security
.. _redis in docker: https://hub.docker.com/r/_/redis/
.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/
.. _strong encryption settings: https://mozilla.github.io/server-side-tls/ssl-config-generator/
doc/admin/installation/general.rst
+2 -2
View File
@@ -29,7 +29,7 @@ Database
Reverse proxy
pretix needs to deliver some static content to your users (e.g. CSS, images, ...). While pretix is capable of
doing this, having this handled by a proper webserver like **nginx** or **Apache** will be much faster. Also, you
doing this, having this handled by a proper web server like **nginx** or **Apache** will be much faster. Also, you
need a proxying web server in front to provide SSL encryption.
.. warning:: Do not ever run without SSL in production. Your users deserve encrypted connections and thanks to
@@ -50,6 +50,6 @@ Redis
* Queuing and result storage for the task worker queue
RabbitMQ
RabbitMQ can be used as a more advanced queue manager for the task workers, if necessary.
RabbitMQ can be used as a more advanced queue manager for the task workers if necessary.
.. _Let's Encrypt: https://letsencrypt.org/