From 2c42c6769baef1e2caff1edebb6a28d0fa9a2f71 Mon Sep 17 00:00:00 2001 From: Johannes Heuel Date: Fri, 7 Jun 2024 14:35:53 +0200 Subject: [PATCH] add deployment instructions to readme --- README.md | 25 ++++++++++++++++++++++++- docker-compose.yml | 8 -------- 2 files changed, 24 insertions(+), 9 deletions(-) delete mode 100644 docker-compose.yml diff --git a/README.md b/README.md index c275cee..d34b56b 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,27 @@

# 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`. diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index bc5e180..0000000 --- a/docker-compose.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -services: - ohrwurm: - build: . - container_name: ohrwurm - restart: unless-stopped - env_file: - - .env