Update and expand the GUIDE (merges #3)

This commit is contained in:
R. Miles McCain
2020-05-02 11:00:40 -04:00
parent f33e0e342c
commit 34e698e309
7 changed files with 43 additions and 198 deletions

View File

@@ -2,12 +2,6 @@
# set to configure Shynet, as well as information about their
# effects. Make a copy of this file to configure your deployment.
# Whether to perform checks and setup at startup. For most setups,
# the recommended value is True.
PERFORM_CHECKS_AND_SETUP=True
# Database settings (PostgreSQL)
DB_NAME=shynet_db
DB_USER=shynet_db_user
@@ -44,10 +38,10 @@ SCRIPT_HEARTBEAT_FREQUENCY=5000
# them to be able to create services of their own.
ONLY_SUPERUSERS_CREATE=True
# If PERFORM_CHECKS_AND_SETUP is True, the following values will be set on
# first run. After they are set once, they won't have any effect.
# (Changing these values WILL NOT affect your Shynet instance.)
#
# Whether to perform checks and setup at startup. For most setups,
# the recommended value is True.
PERFORM_CHECKS_AND_SETUP=True
# Your admin user's email. A temporary password will be printed
# to the console on first run.
SHYNET_ADMIN_EMAIL=you@example.com
@@ -56,4 +50,10 @@ SHYNET_ADMIN_EMAIL=you@example.com
SHYNET_HOST=shynet.example.com
# What you'd like to call your Shynet instance.
SHYNET_WHITELABEL=My Shynet Instance
SHYNET_WHITELABEL=My Shynet Instance
# Redis and queue settings; not necessary for single-instance deployments.
# Don't uncomment these unless you know what you are doing!
# REDIS_CACHE_LOCATION=redis://redis.default.svc.cluster.local/0
# If CELERY_BROKER_URL is set, make sure CELERY_TASK_ALWAYS_EAGER is False
# CELERY_BROKER_URL=redis://redis.default.svc.cluster.local/1