diff --git a/dist.env b/.env.example similarity index 69% rename from dist.env rename to .env.example index d150683..5bb66fc 100644 --- a/dist.env +++ b/.env.example @@ -7,25 +7,24 @@ # If !false, Next's bundle(s) will be analyzed and report files generated ANALYZE=false -# This is the default NODE_ENV setting for the application. Recognized values: -# development -# test -# production +# This will overwrite the NODE_ENV setting for the compiled application. This +# value is also used for inline replacements when building externals. # -# This can be overwritten in the cli, i.e. `NODE_ENV=production npm run -# test-ib`. Note that this is ignored with `npm run build-externals`. -NODE_ENV=development +# Recognized values: test development production +# Default value: empty +NODE_ENV= # The delete/hash of the imgur album used to store images uploaded via the API. -# See: https://apidocs.imgur.com/#c85c9dfc-7487-4de2-9ecd-66f727cf3139 -IMGUR_ALBUM_HASH= +# An empty value is not allowed. See: +# https://apidocs.imgur.com/#c85c9dfc-7487-4de2-9ecd-66f727cf3139 +IMGUR_ALBUM_HASH=xxx -# The client-id authorization token used to interact with the imgur API. -# See: https://api.imgur.com/#registerapp -IMGUR_CLIENT_ID= +# The client-id authorization token used to interact with the imgur API. An +# empty value is not allowed. See: https://api.imgur.com/#registerapp +IMGUR_CLIENT_ID=xxx # MongoDB connect URI -# Specify auth credentials if necessary +# Specify auth credentials if necessary. An empty value is now allowed. # MUST SPECIFY A DATABASE AT THE END! e.g. mongodb://.../your-database-here MONGODB_URI=mongodb://127.0.0.1:27017/hscc-api-ghostmeme @@ -125,9 +124,43 @@ PRUNE_DATA_MAX_USERS=3400 # amount. Oldest entries are deleted first. PRUNE_DATA_MAX_MEMES=35540 -# The size of the memes collection will not be allowed to exceed this +# The size of the uploads collection will not be allowed to exceed this # amount. Oldest entries are deleted first. PRUNE_DATA_MAX_UPLOADS=10000 +# The number of users created when initializing the database. +INIT_DATA_USERS=100 + +# The number of memes created per-user when initializing the database. This +# includes some combination of story memes and public memes but does not include +# chats or comments. +INIT_DATA_USER_MEMES=10 + +# The maximum number of friends generated users will immediately add, bypassing +# the "request" phase. A user can end up with dramatically more friends than +# this number! +# +# Additionally, the following relation must hold: INIT_DATA_USER_MAX_FRIENDS + +# INIT_DATA_USER_MAX_REQUESTS < INIT_DATA_USERS +INIT_DATA_USER_MAX_FRIENDS=3 + +# The maximum number of outgoing friend requests generated users will have. +# +# Additionally, the following relation must hold: +# INIT_DATA_USER_MAX_FRIENDS + INIT_DATA_USER_MAX_REQUESTS < INIT_DATA_USERS +INIT_DATA_USER_MAX_REQUESTS=5 + +# The maximum number of chat threads a generated user will _initiate_. A user +# can end up having dramatically more chats than this number! +INIT_DATA_USER_MAX_CHATS=1 + +# The maximum number of friend's stories under which a generated user will +# _initiate_ a comment thread. A user can end up being involved in dramatically +# more comment threads than this number! +INIT_DATA_USER_MAX_COMMENTS=3 + +# The span of time over which generated events will have "elapsed". +INIT_DATA_START_MINS_AGO=60 + ### TOOLS FRONTEND VARIABLES ### # (optional unless using tools)