[](https://github.com/Griefed/docker-Curseforge-Bot)
[](https://www.griefed.de)
[](https://www.griefed.de/blog)
[](https://fleet.griefed.de)
[](https://github.com/Griefed)
[](https://hub.docker.com/u/griefed)
---
# docker-Curseforge-Bot
[](https://hub.docker.com/repository/docker/griefed/curseforge-bot)
[](https://hub.docker.com/repository/docker/griefed/curseforge-bot)
[](https://hub.docker.com/repository/docker/griefed/curseforge-bot)
[](https://hub.docker.com/repository/docker/griefed/curseforge-bot)
[](https://github.com/Griefed/docker-Curseforge-Bot)
[](https://github.com/Griefed/docker-Curseforge-Bot)
A discord bot, which informs users about new files of specific mods
[](https://github.com/ErdbeerbaerLP/Curseforge-Bot)
---
Creates a Container which runs [ErdbeerbaerLP's](https://github.com/ErdbeerbaerLP) [Curseforge-Bot](https://github.com/ErdbeerbaerLP/Curseforge-Bot), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on https://github.com/ErdbeerbaerLP/Curseforge-Bot.
The [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay).
Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier
# Deployment
Tags | Description
-----|------------
`latest` | Using the `latest` tag will pull the latest image for amd64/x86_64 architecture.
`arm` | Using the `arm`tag will pull the latest image for arm architecture. Use this if you intend on running the container on a Raspberry Pi 3B, for example.
## Pre-built images
```docker-compose.yml
version: '3.6'
services:
curseforge-bot:
container_name: curseforge-bot
image: griefed/curseforge-bot
restart: unless-stopped
volumes:
- ./path/to/config:/config
environment:
- TZ=Europe/Berlin
- PUID=1000 # User ID
- PGID=1000 # Group ID
- DISCORD_BOT_TOKEN=
- DISCORD_CHANNEL_ID=
- PROJECT_ID=
- ROLE_ID=
- FILE_LINK=
- DESCRIPTION=
- CHANGELOG_FORMAT=
- GITHUB_TOKEN=
- GITHUB_REPO=
```
## Raspberry Pi
To run this container on a Raspberry Pi, use the `arm`-tag. I've tested it on a Raspberry Pi 3B.
`griefed/curseforge-bot:arm`
# Configuration
Configuration | Explanation
------------ | -------------
[Restart policy](https://docs.docker.com/compose/compose-file/#restart) | "no", always, on-failure, unless-stopped
config volume | Contains config files and logs.
data volume | Contains your/the containers important data.
TZ | Timezone
PUID | for UserID
PGID | for GroupID
DISCORD_BOT_TOKEN | Your discord bot-token
DISCORD_CHANNEL_ID | The ID of the channel you want the bot to post in
PROJECT_ID | The ID of your Curseforge project
ROLE_ID | (Optional) The ID of the discord role mentioned when the bot makes a post
FILE_LINK | `direct`-link to file or `curse`forge-link on project page or `nolink`.
DESCRIPTION | This sets the text that appears as the message description in the update notification
CHANGELOG_FORMAT | `yml` or `md` or `css`. Only choose one syntax. Can be very usefull if project owner/author uses discord MarkDown formatting in their changelog.
GITHUB_TOKEN | (Optional) Required if you want the cache of the bot to be synched to a github repository. Create an github access token with full "Repo" access (https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
GITHUB_REPO | (Optional) If using GITHUB_TOKEN this will be the name of the repo where the bot will store the cache
More information at [the Curseforge-Bot wiki](https://github.com/ErdbeerbaerLP/Curseforge-Bot/wiki).
## Adding more projects to track
If you have multiple projects in Curseforge which you want to track with this bot, you need to manually edit the bot.conf file which is created after container creation. Here's an example for multiple project IDs and how it's formatted:
```
ids = [
# Project ID
"430517",
"438915",
"378473",
"378719"
]
```
Every new project ID need to be in "" followed by a `,` if an additional ID follows. Last ID must not have a `,` at the end.
## User / Group Identifiers
When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
# Building the image yourself
Use the [Dockerfile](https://github.com/Griefed/docker-Curseforge-Bot/Dockerfile) to build the image yourself, in case you want to make any changes to it
docker-compose.yml:
```docker-compose.yml
version: '3.6'
services:
container_name: curseforge-bot
image: griefed/curseforge-bot:arm
restart: unless-stopped
volumes:
- ./path/to/config:/config
environment:
- TZ=Europe/Berlin
- PUID=1000 # User ID
- PGID=1000 # Group ID
- DISCORD_BOT_TOKEN=
- DISCORD_CHANNEL_ID=
- PROJECT_ID=
- ROLE_ID=
- FILE_LINK=
- DESCRIPTION=
- CHANGELOG_FORMAT=
- GITHUB_TOKEN=
- GITHUB_REPO=
```
1. Clone the repository: `git clone https://github.com/Griefed/docker-Curseforge-Bot.git ./docker-Curseforge-Bot`
1. Prepare docker-compose.yml file as seen above
1. `docker-compose up -d --build curseforge-bot`
1. ???
1. Profit!