rescue/khaganat-web
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity

Add the README

Browse source
This commit is contained in:
Rodolphe Breard 2018-01-26 21:28:45 +01:00
parent 2953a90c55
commit fce04daaaa
1 changed files with 32 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md Normal file
View file

@ -0,0 +1,32 @@
# 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.