Skip to content
Snippets Groups Projects
Commit 38959116 authored by Griefed's avatar Griefed :joystick:
Browse files

- More documentation regarding GitHub variables

- Example for tracking multiple Curseforge projects
parent 99755e4f
No related branches found
No related tags found
No related merge requests found
...@@ -48,11 +48,11 @@ test_1: ...@@ -48,11 +48,11 @@ test_1:
- docker build --network host --tag $CI_REGISTRY_IMAGE:arm . - docker build --network host --tag $CI_REGISTRY_IMAGE:arm .
- docker push $CI_REGISTRY_IMAGE:arm - docker push $CI_REGISTRY_IMAGE:arm
#publish_1: publish_1:
# stage: publish stage: publish
# tags: tags:
# - shell - shell
# script: script:
# - docker login -u $DOCKER_USER -p $DOCKER_PASSWORD $DOCKER_REGISTRY - docker login -u $DOCKER_USER -p $DOCKER_PASSWORD $DOCKER_REGISTRY
# - docker build --network host --tag $DOCKER_USER/$DOCKER_REPO:arm . - docker build --network host --tag $DOCKER_USER/$DOCKER_REPO:arm .
# - docker push $DOCKER_USER/$DOCKER_REPO:arm - docker push $DOCKER_USER/$DOCKER_REPO:arm
\ No newline at end of file \ No newline at end of file
...@@ -84,9 +84,25 @@ ROLE_ID | (Optional) The ID of the discord role mentioned when the bot makes a p ...@@ -84,9 +84,25 @@ ROLE_ID | (Optional) The ID of the discord role mentioned when the bot makes a p
FILE_LINK | `direct`-link to file or `curse`forge-link on project page or `nolink`. 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 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. 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). 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 ## 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`. 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`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment