gvaldap/docs/install.rst

37 lines
840 B
ReStructuredText

.. index:: installation
=======
Install
=======
Working Environment
===================
To get a running work environment use `pipenv`_.
.. _pipenv: https://pipenv.kennethreitz.org/en/latest/
To get started install `pip` and `pipenv` and use `pipenv install --dev`:
.. code-block:: sh
$ apt install python3-pip
$ python3 -m pip install --user -U pipenv
$ pipenv install --dev
.. index:: celery, worker, ldap queue
Running the Celery worker
=========================
gvaldap uses the `Celery`_ distributed task queue system. The gvaldap logix is
executed by a celery worker. After all dependencies are installed you can go
into the gvaldap directory and run the celery worker with:
.. code-block:: sh
$ cd gvaldap
$ pipenv run celery -A ldaptasks worker -Q web -l info
.. _Celery: http://www.celeryproject.org/