Files
ts3gotify/README.md

19 lines
1.5 KiB
Markdown

# ts3gotify
Sends a message to Gotify when a client connects to the server.
## Env
| Variable | Type | Default | Required | Description |
|:--------------:|:------:|-----------|----------|------------------------------------------------------------------|
| LOG_LEVEL | string | info | NO | Log level, 'error', 'info' or 'debug'
| TS3_HOST | string | | YES | IP Address of TS3 server |
| TS3_QUERY_PORT | number | 10011 | YES | Query Port of TS3 server |
| TS3_SERVER_PORT | number | 9987 | YES | Server Port of TS3 Server
| TS3_USERNAME | string | | YES | Username for TS3 Interface. Usually something like 'serveradmin' |
| TS3_PASSWORD | string | | YES | Password for TS3 server. |
| TS3_NICKNAME | string | ts3gotify | NO | Nickname for this application connecting to the TS3 server. |
| GOTIFY_URL | string | | YES | URL of the Gotify server, including http... |
| GOTIFY_TOKEN | string | | YES | App Token for this application on Gotify. |
| GOTIFY_TITLE | string | ts3gotify | NO | Title of Gotify notifications. |
| MODE | array | ['connect'] | NO | Types of notifications ts3gotify sends as JSON array. Available modes: 'connect', 'disconnect', 'moved', 'message' |