llamprecht/jmusicbot-docker
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
yojoshb 2024-04-12 14:25:52 -05:00 committed by GitHub
parent 7713e171c1
commit 03c2efb88c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -3,11 +3,13 @@
![Supports amd64 Architecture](https://img.shields.io/badge/amd64-yes-blueviolet.svg?style=for-the-badge) ![Supports amd64 Architecture](https://img.shields.io/badge/amd64-yes-blueviolet.svg?style=for-the-badge)
![Supports arm64 Architecture](https://img.shields.io/badge/arm64-yes-blueviolet.svg?style=for-the-badge) ![Supports arm64 Architecture](https://img.shields.io/badge/arm64-yes-blueviolet.svg?style=for-the-badge)
A simple Docker container for [JMusicBot](https://github.com/jagrosh/MusicBot) A simple Docker container for [JMusicBot](https://github.com/jagrosh/MusicBot). The container will start up, then download JmusicBot from the projects repository and run it.
## Usage ## Usage
- Place your **config.txt**, **Playlists** folder, and **serversettings.json** file (if you have one) in `/your/path/to/config`. This directory will be shared with the container. - Place your **config.txt**, **Playlists** folder, and **serversettings.json** file (if you have one) in `/your/path/to/config`. This directory will be shared with the container.
- You can specify a JMusicBot version using the environment value `BOT_VERSION`. By default it will use the latest version so you do not have to include the value if you don't want to. > Refer to the documentaion on how to [configure the bot](https://jmusicbot.com/setup/#3-configure-the-bot)
- You can specify a JMusicBot version using the environment variable `BOT_VERSION`. By default the latest version will be downloaded so you don't have to include the value if you want to use latest.
> The version numbers you can use use correspond to the [releases](https://github.com/jagrosh/MusicBot/releases)
### Docker examples ### Docker examples
- Using docker cli - Using docker cli
@ -28,7 +30,7 @@ services:
image: ghcr.io/yojoshb/jmusicbot-docker image: ghcr.io/yojoshb/jmusicbot-docker
container_name: jmusicbot container_name: jmusicbot
environment: environment:
- BOT_VERSION=0.3.9 # You can leave this out if you just want to run the latest version - BOT_VERSION=0.3.9 # You can omit the environment variable if you just want to run the latest version
volumes: volumes:
- /your/path/to/config:/config - /your/path/to/config:/config
restart: unless-stopped restart: unless-stopped