Max Fischer 492a4b977a Initial version for Indico v2
Co-authored-by: Claas Faber <cfaber@geomar.de>
2021-07-28 14:40:12 +02:00

60 lines
1.6 KiB
ReStructuredText

Installation
============
The plugin can be installed using standard Python package managers.
To enable the plugin, it must be added to the configuration file of indico.
.. seealso:: The official `Indico Plugin Installation Guide`_.
Note that at least ``indico`` 2.0 is required, and will be installed automatically if it is missing.
Installing the package
----------------------
The ``indico_sixpay`` plugin must be installed for the python version running ``indico``.
With a standard indico installation, you must activate the indico python virtual environment first.
.. code:: bash
su - indico
source ~/.venv/bin/activate
The latest release version is available for the default python package managers.
You can directly install the module using ``pip``:
.. code:: bash
pip install indico_sixpay
This can also be used to upgrade to a newer version:
.. code:: bash
pip install indico_sixpay --upgrade
Enabling the package
--------------------
All plugins must be enabled in indico's configuration file.
By default, the configuration is located in ``/opt/indico/etc/indico.conf``.
.. code:: python
PLUGINS = {'payment_sixpay'}
Note that if you need multiple plugins, you must all include them in the set of ``PLUGINS``:
.. code:: python
PLUGINS = {'payment_manual', 'payment_paypal', 'payment_sixpay'}
After changing the configuration, trigger a reload of the indico services.
Issue the following commands as ``root``:
.. code:: bash
touch ~/web/indico.wsgi
systemctl restart indico-celery.service
.. _Indico Plugin Installation Guide: https://docs.getindico.io/en/latest/installation/plugins/