add deployment instructions to readme
This commit is contained in:
25
README.md
25
README.md
@@ -6,4 +6,27 @@
|
||||
</p>
|
||||
|
||||
# Deployment
|
||||
Create a `.env` environment file that contains the `DISCORD_TOKEN` and `DISCORD_APP_ID` of your bot, then build the container with `docker-compose build` before running it with `docker-compose up`.
|
||||
To deploy Ohrwurm with Docker, you can use the provided Docker image:
|
||||
```bash
|
||||
docker run -d \
|
||||
--name ohrwurm \
|
||||
--restart unless-stopped \
|
||||
-e DISCORD_TOKEN=YOUR_DISCORD_BOT_TOKEN \
|
||||
-e DISCORD_APP_ID=YOUR_DISCORD_APP_ID \
|
||||
-e ADMIN=YOUR_DISCORD_USER_ID \
|
||||
jheuel/ohrwurm:latest
|
||||
```
|
||||
|
||||
Alternatively, you can create a `docker-compose.yml` file:
|
||||
```yaml
|
||||
services:
|
||||
ohrwurm:
|
||||
container_name: ohrwurm
|
||||
image: jheuel/ohrwurm:latest
|
||||
restart: unless-stopped
|
||||
env:
|
||||
- DISCORD_TOKEN=YOUR_DISCORD_BOT_TOKEN
|
||||
- DISCORD_APP_ID=YOUR_DISCORD_APP_ID
|
||||
- ADMIN=YOUR_DISCORD_USER_ID
|
||||
```
|
||||
and then run the image with `docker compose up`.
|
||||
|
||||
Reference in New Issue
Block a user