rafsaf/twp-server repository overview

⁠Full informations in README on GitHub repository⁠

rafsaf/twp-server:latest

Note, there are also other tags like stage or stable, but latest should be prefered choice.

Contains TWP Django server based on python:3.11.0-bullseye docker image, with nginx/1.18.0⁠ + uwsgi⁠ for webserver stack and tiny Python cron-like lib schedule⁠ for tasks and many more open source software.

Environment variables:

SECRET_KEY - required - app secret key

DEBUG - optional - debug boolean, defaults to False

DJANGO_SUPERUSER_USERNAME - optional - first superuser username, defaults to admin

DJANGO_SUPERUSER_PASSWORD - optional - first superuser password, defaults to admin

DJANGO_SUPERUSER_EMAIL - optional - first superuser email, defaults to [email protected]

MAIN_DOMAIN - optional - main domain used, defaults to localhost

SUB_DOMAIN - optional - sub domain used, defaults to empty string

CSRF_TRUSTED_ORIGINS - optional - list of domain that can perform POST and other unsafe requests to the app eg. https://domain1,https://domain2,http://domain3, see django docs⁠, defaults to http://localhost:8000,http://localhost:7999

POSTGRES_NAME - optional - postgres database name, defaults to postgres

POSTGRES_USER - optional - postgres database user, defaults to postgres

POSTGRES_PASSWORD - optional - postgres database password, defaults to postgres

POSTGRES_HOST - optional - postgres database host, defaults to postgres

POSTGRES_PORT - optional - postgres database port, defaults to 5432

DATABASE_SSL_MODE_ON - optional - Require TLS/SSL when connecting to the database, defaults to False

DEFAULT_FROM_EMAIL - optional - email of site owner, used to send emails on errors and certs expiration, defaults to [email protected]

STRIPE_PUBLISHABLE_KEY - optional - stripe public key, defaults to empty string

STRIPE_SECRET_KEY - optional - stripe secret key, defaults to empty string

STRIPE_ENDPOINT_SECRET - optional - stripe endpoint, defaults to empty string

EMAIL_BACKEND - optional - email backend, refer to django docs, defaults to django.core.mail.backends.console.EmailBackend

AWS_ACCESS_KEY_ID - optional - AWS SES account key id, defaults to empty string

AWS_SECRET_ACCESS_KEY - optional - AWS SES account secret, defaults to empty string

AWS_SES_REGION_NAME - optional - AWS SES region, defaults to empty string

AWS_SES_REGION_ENDPOINT - optional - AWS SES region endpoint, defaults to empty string

METRICS_EXPORT_ENDPOINT_SECRET - optional - secret that allow (prometheus scrapers) access to domain.com/api/metrics/?token=..., defaults to secret

UWSGI_PROCESSES - optional - number of uwsgi processes spawned in the container, defaults to 1

PREMIUM_ACCOUNT_VALIDATION_ON - optional - is premium account required to create more targets, defaults to False

PREMIUM_ACCOUNT_MAX_TARGETS_FREE - optional - max targets allowed without premium account, defaults to 25

REGISTRATION_OPEN - optional - is registration on site allowed, defaults to True

JOB_LIFETIME_MAX_SECS - optional - Stops cronjob function after JOB_LIFETIME_MAX_SECS seconds, defaults to 0 and that means it will not stop ever. If number is greater than 0, it must be also greater or equal to 120 (2 min).

JOB_MIN_INTERVAL - optional - minimal time when database info about villages, players, worlds will be updated in minutes, defaults to 10

JOB_MAX_INTERVAL - optional - maximal time when database info about villages, players, worlds will be updated in minutes, defautls to 15