Skip to content
This repository was archived by the owner on Apr 15, 2023. It is now read-only.

Commit ad4c78d

Browse files
Update readme
1 parent faeb184 commit ad4c78d

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

+17-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
# Factorio watchdog for release changes
22

3+
Build trigger for factorio on new releases
4+
35
## Enviroment variables
46

5-
- **GIT_EMAIL**: Email used for creating the commit
6-
- **GIT_NAME**: Name used for creating the commit
7-
- **GITHUB_USER**: Github username used for api calls and git pull&push
8-
- **GITHUB_TOKEN**: Github private token used for api calls and git pull&push
9-
- **DISCORD_WEBHOOK_URL**: Discord webhook url for announcements
7+
Factorio Docker Watchdog must be configured via environment variables.
8+
Below you find a list with all required and optional variables.
9+
10+
### Required
11+
12+
- **GIT_EMAIL**: Email used by git for committing
13+
- **GIT_NAME**: Username used by git for committing
14+
- **GITHUB_USER**: GitHub Username used for api calls, git pull and push
15+
- **GITHUB_TOKEN**: GitHub token used for api calls, git pull and push
16+
- **GITHUB_REPO_OWNER**: GitHub Username/Organization where to push to
17+
- **GITHUB_REPO_NAME**: GitHub Repository where to push to
18+
19+
### Optional
20+
21+
- **DISCORD_WEBHOOK_URL**: Discord webhook url for announcements

0 commit comments

Comments
 (0)