jmusicbot-docker/README.md
yojoshb ee7dd69710
Update README.md
fix shields.io badge
2022-04-13 16:06:01 -05:00

38 lines
1.3 KiB
Markdown

# JMusicBot Docker
[![Release](https://img.shields.io/github/release/jagrosh/MusicBot?color=g&style=for-the-badge)](https://github.com/jagrosh/MusicBot/releases/latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/yojoshb/jmusicbot?color=blue&style=for-the-badge)](https://hub.docker.com/r/yojoshb/jmusicbot)
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/yojoshb/jmusicbot/latest?color=blueviolet&style=for-the-badge)](https://hub.docker.com/r/yojoshb/jmusicbot)
Docker container for [JMusicBot](https://github.com/jagrosh/MusicBot). This uses the latest Minideb image for a small footprint.
## Usage
Place your **config.txt**, **Playlists** folder, and **serversettings.json** file (if you have one) in `yourpath/toconfig` to map it to the container. If you need to access the container you can hop into it and get a shell using:
```bash
docker exec -it jmusicbot /bin/bash
```
---
### Docker CLI
```bash
docker run -dit \
--name=jmusicbot \
-v /yourpath/toconfig:/config \
--restart=unless-stopped \
yojoshb/jmusicbot
```
### Docker Compose
```bash
---
version: "2"
services:
jmusicbot:
image: yojoshb/jmusicbot
container_name: jmusicbot
volumes:
- /yourpath/toconfig:/config
restart: unless-stopped
```