projectmoon
/
tenebrous-dicebot
1
0
Fork 1
Code Issues 12 Pull Requests 1 Projects Releases 10 Wiki Activity

Update readme for new docker image.

This commit is contained in:
projectmoon 2020-09-26 13:25:26 +00:00
parent d0e6ffdc43
commit 908507c28c
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -28,8 +28,8 @@ updated on Docker Hub via a CI/CD pipeline. The `latest` tag always
points to the most recent successful master commit and is considered points to the most recent successful master commit and is considered
unstable, while individual tags are considered stable: unstable, while individual tags are considered stable:
* Unstable: `docker pull projectmoon/chronicle-dicebot:latest` * Unstable: `docker pull ghcr.io/projectmoon/chronicle-dicebot:latest`
* Stable: `docker pull projectmoon/chronicle-dicebot:vX.Y.Z` * Stable: `docker pull ghcr.io/projectmoon/chronicle-dicebot:X.Y.Z`
To create the Docker image, run `docker build -t chronicle-dicebot .` To create the Docker image, run `docker build -t chronicle-dicebot .`
in the root of the repository. in the root of the repository.
@ -125,15 +125,15 @@ as shown above, and will give you the plaintext response.
### Docker Image ### Docker Image
A typical docker run command using the Docker Hub image should look A typical docker run command using the official Docker image should
something like this: look something like this:
``` ```
VERSION="latest" VERSION="latest"
docker run --rm -d --name dicebot \ docker run --rm -d --name dicebot \
-v /path/to/dicebot-config.toml:/config/dicebot-config.toml:ro \ -v /path/to/dicebot-config.toml:/config/dicebot-config.toml:ro \
-v /path/to/cache/:/cache \ -v /path/to/cache/:/cache \
projectmoon/chronicle-dicebot:$VERSION ghcr.io/projectmoon/chronicle-dicebot:$VERSION
``` ```
The Docker image requires two volume mounts: the location of the The Docker image requires two volume mounts: the location of the