StyAndCo/zappyzep
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: documentation updates

Browse source
This commit is contained in:
Dragory 2022-08-07 13:58:47 +03:00
parent c01a4027bd
commit 7d47f36d99
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
2 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.env.example
View file

@ -6,6 +6,8 @@ CLIENT_ID=
CLIENT_SECRET= CLIENT_SECRET=
BOT_TOKEN= BOT_TOKEN=
# The defaults here automatically work for the development environment.
# For production, change localhost:3300 to your domain.
DASHBOARD_URL=https://localhost:3300 DASHBOARD_URL=https://localhost:3300
API_URL=https://localhost:3300/api API_URL=https://localhost:3300/api
@ -28,6 +30,7 @@ DOCKER_USER_GID=
# #
# DOCKER (DEVELOPMENT) # DOCKER (DEVELOPMENT)
# NOTE: You only need to fill in these values for running the development environment. See production config further below.
# #
DOCKER_DEV_WEB_PORT=3300 DOCKER_DEV_WEB_PORT=3300
@ -50,6 +53,7 @@ DOCKER_DEV_SSH_PASSWORD=password
# #
# DOCKER (PRODUCTION) # DOCKER (PRODUCTION)
# NOTE: You only need to fill in these values for running the production environment. See development config above.
# #
DOCKER_PROD_DOMAIN= DOCKER_PROD_DOMAIN=

2
PRODUCTION.md
View file

@ -7,6 +7,8 @@ Zeppelin's production environment - that is, the **bot, API, and dashboard** - u
3. Fill in the missing values in `.env` 3. Fill in the missing values in `.env`
4. Run `docker compose -f docker-compose.production.yml up -d` 4. Run `docker compose -f docker-compose.production.yml up -d`
**Note:** The dashboard and API are exposed with a self-signed certificate. It is recommended to set up a proxy with a proper certificate in front of them. Cloudflare is a popular choice here.
## Updating the bot ## Updating the bot
### One-click script ### One-click script