Zeppelin production environment

Zeppelin's production environment - that is, the bot, API, and dashboard - uses Docker.

Detailed self-hosting guide

Follow this guide to install Docker.
Fork the repository using git clone https://github.com/ZeppelinBot/Zeppelin.
CD into the repository using cd Zeppelin.
Copy the .env file using cp .env.example .env.
Fill in the missing .env values using nano .env.
Run docker compose -f docker-compose.production.yml up -d.

Questions or need support? Join the self-hosting server: https://discord.gg/uTcdUmF6Q7

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

One-click script

If you've downloaded the bot's files by cloning the git repository, you can use update.sh to update the bot.

Manual instructions

Shut the bot down: docker compose -f docker-compose.production.yml stop
Update the files (e.g. git pull)
Start the bot again: docker compose -f docker-compose.production.yml start

Ephemeral hotfixes

If you need to make a hotfix to the bot's source files directly on the server:

Shut the bot down: docker compose -f docker-compose.production.yml stop
Make your edits
Start the bot again: docker compose -f docker-compose.production.yml start

Note that you can't edit the compiled files directly as they're overwritten when the environment starts. Only edit files in /backend/src, /shared/src, and /dashboard/src.

Make sure to revert any hotfixes before updating the bot normally.

View logs

To view real-time logs, run docker compose -f docker-compose.production.yml logs -t -f

1.8 KiB Raw Blame History