diff --git a/doc/admin/errors.rst b/doc/admin/errors.rst new file mode 100644 index 000000000..028c2a87d --- /dev/null +++ b/doc/admin/errors.rst @@ -0,0 +1,40 @@ +.. _`admin-errors`: + +Dealing with errors +=================== + +If you encounter an error in pretix, please follow the following steps to debug it: + +* If the error message is shown on a **white page** and the last line of the error includes "nginx", the error is not with pretix + directly but with your nginx webserver. This might mean that pretix is not running, but it could also be something else. + Please first check your nginx error log. The default location is ``/var/log/nginx/error.log``. + + * If it turns out pretix is not running, check the output of ``docker logs pretix`` for a docker installation and + ``journalctl -u pretix-web.service`` for a manual installation. + +* If the error message is an "**Internal Server Error**" in purple pretix design, please check pretix' log file which by default is at + ``/var/pretix-data/logs/pretix.log`` if you installed with docker and ``/var/pretix/data/logs/pretix.log`` otherwise. If you don't + know how to interpret it, open a discussion on GitHub with the relevant parts of the log file. + + * If the error message includes ``/usr/bin/env: ‘node’: No such file or directory``, you forgot to install ``node.js`` + + * If the error message includes ``OfflineGenerationError``, you might have forgot to run the ``rebuild`` step after a pretix update + or plugin installation. + + * If the error message mentions your database server or redis server, make sure these are running and accessible. + +* If pretix loads fine but certain actions (creating carts, orders, or exports, downloading tickets, sending emails) **take forever**, + ``pretix-worker`` is not running. Check the output of ``docker logs pretix`` for a docker installation and + ``journalctl -u pretix-worker.service`` for a manual installation. + +* If the page loads but all **styles are missing**, you probably forgot to update your nginx configuration file after an upgrade of your + operating system's python version. + + +If you are unable to debug the issue any further, please open a **discussion** on GitHub in our `Q&A Forum`_. Do **not** open an issue +right away, since most things turn out not to be a bug in pretix but a mistake in your server configuration. Make sure to include +relevant log excerpts in your question. + +If you're a pretix Enterprise customer, you can also reach out to support@pretix.eu with your issue right away. + +.. _Q&A Forum: https://github.com/pretix/pretix/discussions/categories/q-a diff --git a/doc/admin/updates.rst b/doc/admin/updates.rst new file mode 100644 index 000000000..dc9cc53ff --- /dev/null +++ b/doc/admin/updates.rst @@ -0,0 +1,44 @@ +.. _`update_notes`: + +Update notes +============ + +pretix receives regular feature and bugfix updates and we highly encourage you to always update to +the latest version for maximum quality and security. Updates are announces on our `blog`_. There are +usually 10 feature updates in a year, so you can expect a new release almost every month. + +Pure bugfix releases are only issued in case of very critical bugs or security vulnerabilities. In these +case, we'll publish bugfix releases for the last three stable release branches. + +Compatibility to plugins and in very rare cases API clients may break. For in-depth details on the +API changes of every version, please refer to the release notes published on our blog. + +Upgrade steps +------------- + +For the actual upgrade, you can usually just follow the steps from the installation guide for :ref:`manual installations ` +or :ref:`docker installations ` respectively. +Generally, it is always strongly recommended to perform a :ref:`backup ` first. +It is possible to skip versions during updates, although we recommend not skipping over major version numbers +(i.e. if you want to go from 2.4 to 4.4, first upgrade to 3.0, then upgrade to 4.0, then to 4.4). + +In addition to these standard update steps, the following list issues steps that should be taken when you upgrade +to specific versions for pretix. If you're skipping versions, please read the instructions for every version in +between as well. + +Upgrade to 4.4.0 or newer +""""""""""""""""""""""""" + +pretix 4.4 introduces a new data structure to store historical financial data. If you already have existing +data in your database, you will need to backfill this data or you might get incorrect reports! This is not +done automatically as part of the usual update steps since it can take a while on large databases and you might +want to do it in parallel while the system is already running again. Please execute the following command:: + + (venv)$ python -m pretix create_order_transactions + +Or, with a docker installation:: + + $ docker exec -it pretix.service pretix create_order_transactions + + +.. _blog: https://pretix.eu/about/en/blog/