khaganat-web/README.md
2018-01-27 18:58:36 +01:00

34 lines
1,010 B
Markdown

# Khaganat's web site
## Requirements
* Python 3
* pipenv
* git
## Quick deployment
```
git clone https://git.khaganat.net/Tycho/khaganat-web.git khaganat-web
cd khaganat-web
vim .env
pipenv --python 3 --update
pipenv run ./manage.py migrate
pipenv run ./manage.py collectstatic
```
## Environment variables
You can set the following variables in the `.env` file:
* `KHAGANAT_SECRET_KEY` (required): Django's secret key, keep it secret.
* `KHAGANAT_DEBUG`: Debug mode, default is false.
* `KHAGANAT_HOSTNAMES`: Allowed hostnames, coma separated.
* `KHAGANAT_LANGUAGE_CODE`: Language code, default is `fr`.
* `KHAGANAT_TIME_ZONE`: Time zone, default is `Europe/Paris`.
* `KHAGANAT_STATIC_URL`: URL for static files, default is `/static/`.
* `KHAGANAT_STATIC_ROOT`: Absolute path to the directory where static files should be collected.
* `KHAGANAT_LOGS_MIN_DAYS`: Numbers of days before logs are hidden, default is 7.
* `KHAGANAT_LOGS_MAX_DAYS`: Number of days before logs are published, default is 0.