StyAndCo/zeppelin
3
0
Fork 0
mirror of https://github.com/ZeppelinBot/Zeppelin.git synced 2025-03-15 05:41:51 +00:00
Code Releases Activity

docs: fixes/tweaks to docker docs

Browse source
This commit is contained in:
Dragory 2022-08-07 13:52:04 +03:00
parent 9bd1b97a11
commit 561f91949d
No known key found for this signature in database
GPG key ID: 5F387BA66DF8AAC1
2 changed files with 9 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
DEVELOPMENT.md
View file

@ -17,7 +17,7 @@ Below you can find instructions for setting up the environment and getting start
1. Install Docker 1. Install Docker
2. Make a copy of `.env.example` called `.env` 2. Make a copy of `.env.example` called `.env`
3. Fill in the missing values in `.env` 3. Fill in the missing values in `.env`
4. Run `docker-compose up` to start the development environment 4. Run `docker compose -f docker-compose.development.yml up` to start the development environment
5. In VSCode: Install the `Remote - SSH` plugin 5. In VSCode: Install the `Remote - SSH` plugin
6. In VSCode: Run `Remote-SSH: Connect to Host...` 6. In VSCode: Run `Remote-SSH: Connect to Host...`
* As the address, use `ubuntu@127.0.0.1:3002` (where `3002` matches `DOCKER_DEV_SSH_PORT` in `.env`) * As the address, use `ubuntu@127.0.0.1:3002` (where `3002` matches `DOCKER_DEV_SSH_PORT` in `.env`)
@ -28,7 +28,7 @@ Below you can find instructions for setting up the environment and getting start
1. Install Docker 1. Install Docker
2. Make a copy of `.env.example` called `.env` 2. Make a copy of `.env.example` called `.env`
3. Fill in the missing values in `.env` 3. Fill in the missing values in `.env`
4. Run `docker-compose up` to start the development environment 4. Run `docker compose -f docker-compose.development.yml up` to start the development environment
5. Choose `Connect via SSH` and create a new connection: 5. Choose `Connect via SSH` and create a new connection:
* Username: `ubuntu` * Username: `ubuntu`
* Host: `127.0.0.1` * Host: `127.0.0.1`
@ -43,7 +43,7 @@ Below you can find instructions for setting up the environment and getting start
1. Install Docker 1. Install Docker
2. Make a copy of `.env.example` called `.env` 2. Make a copy of `.env.example` called `.env`
3. Fill in the missing values in `.env` 3. Fill in the missing values in `.env`
4. Run `docker-compose up` to start the development environment 4. Run `docker compose -f docker-compose.development.yml up` to start the development environment
5. Use the following credentials for connecting with your IDE: 5. Use the following credentials for connecting with your IDE:
* Host: `127.0.0.1` * Host: `127.0.0.1`
* Port: `3002` (matching the `DOCKER_DEV_SSH_PORT` value in `.env`) * Port: `3002` (matching the `DOCKER_DEV_SSH_PORT` value in `.env`)

12
PRODUCTION.md
View file

@ -5,7 +5,7 @@ Zeppelin's production environment - that is, the **bot, API, and dashboard** - u
1. Install Docker on the machine running the bot 1. Install Docker on the machine running the bot
2. Make a copy of `.env.example` called `.env` 2. Make a copy of `.env.example` called `.env`
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 -d up` 4. Run `docker compose -f docker-compose.production.yml up -d`
## Updating the bot ## Updating the bot
@ -13,15 +13,15 @@ Zeppelin's production environment - that is, the **bot, API, and dashboard** - u
If you've downloaded the bot's files by cloning the git repository, you can use `update.sh` to update the bot. If you've downloaded the bot's files by cloning the git repository, you can use `update.sh` to update the bot.
### Manual instructions ### Manual instructions
1. Shut the bot down: `docker-compose -f docker-compose.production.yml down` 1. Shut the bot down: `docker compose -f docker-compose.production.yml stop`
2. Update the files (e.g. `git pull`) 2. Update the files (e.g. `git pull`)
3. Start the bot again: `docker-compose -f docker-compose.production.yml -d up` 3. Start the bot again: `docker compose -f docker-compose.production.yml start`
### Ephemeral hotfixes ### Ephemeral hotfixes
If you need to make a hotfix to the bot's source files directly on the server: If you need to make a hotfix to the bot's source files directly on the server:
1. Shut the bot down: `docker-compose -f docker-compose.production.yml down` 1. Shut the bot down: `docker compose -f docker-compose.production.yml stop`
2. Make your edits 2. Make your edits
3. Start the bot again: `docker-compose -f docker-compose.production.yml -d up` 3. 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. 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`. Only edit files in `/backend/src`, `/shared/src`, and `/dashboard/src`.
@ -29,4 +29,4 @@ Only edit files in `/backend/src`, `/shared/src`, and `/dashboard/src`.
Make sure to revert any hotfixes before updating the bot normally. Make sure to revert any hotfixes before updating the bot normally.
## View logs ## View logs
To view real-time logs, run `docker-compose -f docker-compose.production.yml -t logs` To view real-time logs, run `docker compose -f docker-compose.production.yml -t -f logs`