3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-07-10 04:27:20 +00:00

Update .env.example

This commit is contained in:
Dalk 2023-04-05 17:13:10 -04:00 committed by GitHub
parent 4159df83bf
commit 7bfa8e67fa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,4 +1,4 @@
# 32 character encryption key
# This is 32 character encryption key used to encrypt certain data in the database, you can generate this by using `openssl rand -hex 16`, or a password generator.
KEY=
# Values from the Discord developer portal
@ -8,10 +8,16 @@ BOT_TOKEN=
# The defaults here automatically work for the development environment.
# For production, change localhost:3300 to your domain.
# ----------------------------------------------------------------------------------------------------------------------------------------
# This is the URL you and other bot managers will use to access the dashboard to manage server configs.
# If you are using a domain, fill in https://DOMAIN, else if you are using a IP, fill in https://IP
DASHBOARD_URL=https://localhost:3300
# This is used by the dashboard to access the bot internals; also used by Discord to redirect you back to the dashboard after you log in.
# Use your dashboard URL, but add `/api` at the end
API_URL=https://localhost:3300/api
# Comma-separated list of user IDs who should have access to the bot's global commands
# These are staff to help manage the bot itself. These are not server staff that would manage bot configs.
# If there will be multiple people managing the bot, separate the user IDs with commas.
STAFF=
# A comma-separated list of server IDs that should be allowed by default
@ -20,7 +26,7 @@ DEFAULT_ALLOWED_SERVERS=
# When using the Docker-based development environment, this is only used internally. The API will be available at localhost:DOCKER_DEV_WEB_PORT/api.
API_PORT=3000
# Only required if relevant feature is used
# Phisherman is a live database used for identifying malicious, scam, and phishing links. Uncomment the row if you have an api key.
#PHISHERMAN_API_KEY=
# The user ID and group ID that should be used within the Docker containers
@ -33,14 +39,18 @@ DOCKER_USER_GID=
# NOTE: You only need to fill in these values for running the development environment. See production config further below.
#
# The port used to access the dashboard
# If you have a webserver or another service that uses port 3300 running on the host computer, change the port to something else, e.g. 3301
DOCKER_DEV_WEB_PORT=3300
# The MySQL database running in the container is exposed to the host on this port,
# allowing access with database tools such as DBeaver
DOCKER_DEV_MYSQL_PORT=3001
# Password for the Zeppelin database user
# Do not use $'"(){}# in the password
DOCKER_DEV_MYSQL_PASSWORD=
# Password for the MySQL root user
# Do not use $'"(){}# in the password
DOCKER_DEV_MYSQL_ROOT_PASSWORD=
# The development environment container has an SSH server that you can connect to.
@ -56,14 +66,20 @@ DOCKER_DEV_SSH_PASSWORD=password
# NOTE: You only need to fill in these values for running the production environment. See development config above.
#
# If you are using a domain to access the dashboard, put the domain here.
# Put only the domain (e.g. zeppelin.gg) and not the URL.
DOCKER_PROD_DOMAIN=
# This is the port used to access the dashboard.
# If you have a webserver or another service that uses port 443 running on the host computer, change the port to something else, e.g. 444
DOCKER_PROD_WEB_PORT=443
# The MySQL database running in the container is exposed to the host on this port,
# allowing access with database tools such as DBeaver
DOCKER_PROD_MYSQL_PORT=3001
# Password for the Zeppelin database user
# Do not use $'"(){}# in the password
DOCKER_PROD_MYSQL_PASSWORD=
# Password for the MySQL root user
# Do not use $'"(){}# in the password
DOCKER_PROD_MYSQL_ROOT_PASSWORD=
# You only need to set these if you're running an external database.