Comment the defaults, with instructions to uncomment and change the values.

This commit is contained in:
CaitSith2 2021-11-17 23:38:30 -08:00
parent 9cb24280fa
commit f7e89695e5
1 changed files with 20 additions and 18 deletions

View File

@ -1,50 +1,52 @@
# This is a sample configuration for the Web host. If you wish to change any of these, rename this file to config.yaml # This is a sample configuration for the Web host.
# If you wish to change any of these, rename this file to config.yaml
# Default values are shown here. Uncomment and change the values as desired.
# TODO # TODO
SELFHOST: true #SELFHOST: true
# Maximum concurrent world gens # Maximum concurrent world gens
GENERATORS: 8 #GENERATORS: 8
# TODO # TODO
SELFLAUNCH: true #SELFLAUNCH: true
# TODO # TODO
DEBUG: false #DEBUG: false
# Web hosting port # Web hosting port
PORT: 80 #PORT: 80
# Place where uploads go. # Place where uploads go.
UPLOAD_FOLDER: uploads #UPLOAD_FOLDER: uploads
# Maximum upload size. Default is 64 megabyte (64 * 1024 * 1024) # Maximum upload size. Default is 64 megabyte (64 * 1024 * 1024)
MAX_CONTENT_LENGTH: 67108864 #MAX_CONTENT_LENGTH: 67108864
# Secret key used to determine important things like cookie authentication of room/seed page ownership. # Secret key used to determine important things like cookie authentication of room/seed page ownership.
# If you wish to deploy, uncomment the following line and set it to something not easily guessable. # If you wish to deploy, uncomment the following line and set it to something not easily guessable.
# SECRET_KEY: "Your secret key here" # SECRET_KEY: "Your secret key here"
# TODO # TODO
JOB_THRESHOLD: 2 #JOB_THRESHOLD: 2
# waitress uses one thread for I/O, these are for processing of view that get sent # waitress uses one thread for I/O, these are for processing of view that get sent
WAITRESS_THREADS: 10 #WAITRESS_THREADS: 10
# Database provider details: # Database provider details:
PONY: #PONY:
provider: "sqlite" # provider: "sqlite"
filename: "ap.db3" # This MUST be the ABSOLUTE PATH to the file. # filename: "ap.db3" # This MUST be the ABSOLUTE PATH to the file.
create_db: true # create_db: true
# Maximum number of players that are allowed to be rolled on the server. After this limit, one should roll locally and upload the results. # Maximum number of players that are allowed to be rolled on the server. After this limit, one should roll locally and upload the results.
MAX_ROLL: 20 #MAX_ROLL: 20
# TODO # TODO
CACHE_TYPE: "simple" #CACHE_TYPE: "simple"
# TODO # TODO
JSON_AS_ASCII: false #JSON_AS_ASCII: false
# Patch target. This is the address encoded into the patch that will be used for client auto-connect. # Patch target. This is the address encoded into the patch that will be used for client auto-connect.
PATCH_TARGET: archipelago.gg #PATCH_TARGET: archipelago.gg