You've already forked snikket-web-portal
6d50b1c2c7
Dependency versions are generally not useful, unless you are developing or otherwise outside of a normal release situation: If you are on a normal release, we can figure out the dep versions by looking at the docker image. To reduce the amount of information displayed and the amount of information which needs to be conveyed in case of problems, we only show the web portal and prosody versions to admins, unless debug mode is enabled. The behaviour that versions are only shown to logged in admins (unless debug mode is enabled) remains unchanged. Fixes #115.
Snikket Web Portal
Development quickstart
$ direnv allow
$ cp example.env .env
$ $EDITOR .env # to adapt the configuration to your needs
$ pip install -r requirements.txt
$ pip install -r build-requirements.txt
$ make
$ quart run
Configuring
Purely via environment variables
For a list of required and understood environment variables as well as their
semantics, please refer to example.env.
Via python code
In addition to statically setting environment variables, it is possible to
initialise the environment variables in a python file. To do that, pass the
path to the python file as SNIKKET_WEB_PYENV environment variable.
The python file is evaluated before further environment variable processing takes place. Every name defined in that file which begins with an upper case ASCII letter is included in the processing of environment variables for configuration purposes.
For a (non-productive) example of such a file, see example.env.py.