rescue/khaganat-web
1
0
Fork 0
Code Issues 6 Pull requests Projects Releases Packages Wiki Activity
New website suggestion. Testing only.
54 commits 1 branch 0 tags 1.6 MiB
CSS 69.3%
Python 21.3%
HTML 9%
JavaScript 0.4%
Find a file
Rodolphe Breard 1558b0e6fd Improve the readme file
2018-05-27 11:28:13 +02:00
khaganat Improve the way the login url is handled 2018-03-03 11:30:29 +01:00
logs Add an inline admin interface to the log module 2018-02-04 20:28:09 +01:00
navbar Use view_name instead of func 2018-03-02 19:32:56 +01:00
neluser Add a migration for the neluser module 2018-02-04 20:41:11 +01:00
pages Add markdown support for flat pages 2018-02-25 20:46:41 +01:00
.gitignore Add .sql files to the ignore list 2018-01-27 21:16:37 +01:00
LICENSE.txt Add the AGPL license 2018-01-26 21:49:00 +01:00
manage.py first commit 2018-01-13 12:29:33 +01:00
Pipfile Add gunicorn to dev-packages 2018-03-03 11:18:59 +01:00
Pipfile.lock Add gunicorn to dev-packages 2018-03-03 11:18:59 +01:00
README.md Improve the readme file 2018-05-27 11:28:13 +02:00

README.md

Khaganat's web site

Requirements

  • Python 3.6 or newer
  • pipenv
  • git
  • gettext

Quick deployment

git clone https://git.khaganat.net/Tycho/khaganat-web.git khaganat-web
cd khaganat-web
vim .env
pipenv --three --update
pipenv run ./manage.py migrate
pipenv run ./manage.py collectstatic
pipenv run ./manage.py compilemessages
pipenv run ./manage.py createsuperuser

Then configure your server as you like. One way to deploy is to use Nginx and uWSGI:

You can get the virtualenv's path using pipenv --venv. Do not forget to check the deployment checklist.

Environment variables

You can set the following variables in the .env file:

  • KHAGANAT_SECRET_KEY (required): Django's secret key, keep it secret (tip: generate one using openssl rand -base64 42).
  • 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.
  • KHAGANAT_LOGIN_REDIRECT_URL: URL to redirect after user login. Will be reversed, default is index.
  • KHAGANAT_REGISTER_REQUIRE_VALIDATION: require email validation upon registration, default is true.
  • KHAGANAT_EMAIL_HOST: The host to use for sending email, default is localhost.
  • KHAGANAT_EMAIL_PORT: Port to use for the SMTP server, default is 25.
  • KHAGANAT_EMAIL_HOST_USER: Username to use for the SMTP server, default is empty (no authentication).
  • KHAGANAT_EMAIL_HOST_PASSWORD: Password to use for the SMTP server, default is empty.
  • KHAGANAT_EMAIL_USE_TLS: Whether to use a TLS connection to the SMTP server, default is False.
  • KHAGANAT_EMAIL_SUBJECT_PREFIX: Subject-line prefix for email, default is empty.
  • KHAGANAT_DEFAULT_FROM_EMAIL: Default email address to use, default is no-reply@localhost.
  • KHAGANAT_FORCE_HTTPS: If True, enable the use of KHAGANAT_HTTPS_HEADER_NAME and KHAGANAT_HTTPS_HEADER_VALUE to set the SECURE_PROXY_SSL_HEADER configuration option. Default is False.
  • KHAGANAT_HTTPS_HEADER_NAME: Header name for SECURE_PROXY_SSL_HEADER, default is HTTP_X_FORWARDED_PROTO.
  • KHAGANAT_HTTPS_HEADER_VALUE: Header value for SECURE_PROXY_SSL_HEADER, default is https.