You've already forked snikket-web-portal
42 lines
1.4 KiB
Markdown
42 lines
1.4 KiB
Markdown
# Snikket Web Portal
|
|
|
|
This is the web component of a [Snikket service](https://snikket.org/service/)
|
|
that allows users to manage accounts, and administrators to manage the
|
|
service. For general setup, see the [Snikket install
|
|
guide](https://snikket.org/service/quickstart/). For developers working on
|
|
Snikket, see the development quickstart below.
|
|
|
|
|
|
|
|
## Development quickstart
|
|
|
|
```console
|
|
$ 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`](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`.
|