Improve readme #1

Merged
jheuel merged 2 commits from dev into main 2024-06-07 15:32:29 +02:00
2 changed files with 24 additions and 9 deletions
Showing only changes of commit 2c42c6769b - Show all commits

View File

@@ -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`.

View File

@@ -1,8 +0,0 @@
---
services:
ohrwurm:
build: .
container_name: ohrwurm
restart: unless-stopped
env_file:
- .env