miaowware
/
qrm2
mirror of https://github.com/miaowware/qrm2.git
1
0
Fork 0
Code Issues Actions Projects Releases Wiki Activity

update docker documentation to remove docker hub mentions (#265) 

Fixes #263
This commit is contained in:
classabbyamp 2020-10-06 19:17:02 -04:00 committed by GitHub
parent fa2dded81b
commit 8cb1a8df15
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README-DOCKER.md
View File

@ -23,16 +23,14 @@ This is the easiest method for running the bot without any modifications.
version: '3'
services:
qrm2:
image: "classabbyamp/qrm2:latest"
# OR
# image: "docker.pkg.github.com/miaowware/qrm2/qrm2:latest"
image: "docker.pkg.github.com/miaowware/qrm2/qrm2:latest"
restart: on-failure
volumes:
- "./data:/app/data:rw"
environment:
- PYTHONUNBUFFERED=1
```
> Note that there are two possible sources for the image: docker's and github's registry. Github's registry requires [a few extra steps](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages) during the initial setup.
*Note that Github's registry requires [a few extra steps](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-docker-for-use-with-github-packages) during the initial setup.*
3. Create a subdirectory named `data`.
@ -45,7 +43,7 @@ This is the easiest method for running the bot without any modifications.
$ docker-compose up -d
```
> Run without "-d" to test the bot. (run in foreground)
*Run without "-d" to test the bot (run in foreground).*
@ -81,7 +79,7 @@ This is the easiest method to run the bot with modifications.
$ docker-compose up -d
```
> Run without "-d" to test the bot. (run in foreground)
*Run without "-d" to test the bot (run in foreground).*
@ -113,5 +111,5 @@ This methods is not very nice to use.
```
Where `[image]` is either of:
- `discord-qrm2:local-latest` if you are building your own.
- `classabbyamp/discord-qrm2:latest` if you want to use the prebuilt image.
- `qrm2:local-latest` if you are building your own.
- `docker.pkg.github.com/miaowware/qrm2/qrm2:latest` if you want to use the prebuilt image.