podcheck/default.config at main · sudo-kraken/podcheck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### Custom user variables for podcheck
## Copy this file to "podcheck.config" to make it active
## Can be placed in ~/.config/ or alongside podcheck.sh
##
## Uncomment and set your preferred configuration variables here
## This will not be replaced on updates

#Timeout=10          # Set a timeout (in seconds) per container for registry checkups.
#MaxAsync=10         # Set max asynchronous subprocesses, 1 default, 0 to disable.
#BarWidth=50         # The character width of the progress bar
#AutoMode=true       # Automatic updates, without interaction.
#DontUpdate=true     # No updates; only checking availability without interaction.
#AutoPrune=true      # Auto-Prune dangling images after update.
#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it.
#Notify=true         # Inform - send a preconfigured notification.
#Exclude="one,two"   # Exclude containers, separated by comma.
#DaysOld="5"         # Only update to new images that are N+ days old. Lists too recent with +prefix and age. 2xSlower.
#Stopped="-a"        # Include stopped containers in the check. (Logic: podman ps -a).
#OnlyLabel=true      # Only update if label is set. See readme.
#ForceRestartStacks=true    # Force stop+start stack after update. Caution: restarts once for every updated container within stack.
#DRunUp=true         # Allow updating images for podman run, won't update the container.
#MonoMode=true       # Monochrome mode, no printf colour codes and hides progress bar.
#PrintReleaseURL=true    # Prints custom releasenote urls alongside each container with updates (requires urls.list)
#PrintMarkdownURL=true   # Prints custom releasenote urls as markdown
#OnlySpecific=true   # Only compose up the specific container, not the whole compose stack. (useful for master-compose structure).
#CurlRetryDelay=1    # Time between curl retries
#CurlRetryCount=3    # Max number of curl retries
#CurlConnectTimeout=5    # Time to wait for curl to establish a connection before failing
#DisplaySourcedFiles=false   # Display what files are being sourced/used
#AutoSelfUpdate=true # Allow automatic self updates - caution as this will pull new code and autorun it.
#Notify=true         # Inform - send a preconfigured notification.
#Exclude="one,two"   # Exclude containers, separated by comma.
#BackupForDays=7     # Enable image backups before updating and sets number of days to keep before pruning.

### Notify settings
## All commented values are examples only. Modify as needed.
##
## Uncomment the line below and specify the notification channels you wish to enable in a space separated string
#
#NOTIFY_CHANNELS="apprise bark discord DSM file generic HA gotify matrix ntfy pushbullet pushover slack smtp telegram"
#
## Uncomment the line below and specify the number of seconds to delay notifications to enable snooze
#SNOOZE_SECONDS=86400
#
## Uncomment and set to true to disable notifications when podcheck itself has updates.
#DISABLE_PODCHECK_NOTIFICATION=false
## Uncomment and set to true to disable notifications when notify scripts themselves have updates.
#DISABLE_NOTIFY_NOTIFICATION=false
#
## Apprise configuration variables. Set APPRISE_PAYLOAD to make a CLI call or set APPRISE_URL to make an API request instead.
#APPRISE_PAYLOAD='mailto://myemail:mypass@gmail.com
#                 mastodons://{token}@{host}
#                 pbul://o.gn5kj6nfhv736I7jC3cj3QLRiyhgl98b
#                 tgram://{bot_token}/{chat_id}/'
#APPRISE_URL="http://apprise.mydomain.tld:1234/notify/apprise"
#
# BARK_URL="http://your-bark-server.com"
# BARK_KEY="your_device_key"
# BARK_SERVER_URL="https://api.day.app" # Optional override
# BARK_SOUND="hello"                    # Optional: iOS notification sound
# BARK_GROUP="Podcheck"                 # Optional: iOS notification group
# BARK_ICON_URL=""                      # Optional: URL to a custom icon
#
#DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/<token string>"
#
#DSM_SENDMAILTO="me@mydomain.com"
#DSM_SUBJECTTAG="Email Subject Prefix"
#
#GOTIFY_DOMAIN="https://gotify.domain.tld"
#GOTIFY_TOKEN="token-value"
#
#HA_ENTITY="entity"
#HA_TOKEN="token"
#HA_URL="https://your.homeassistant.url"
#
#MATRIX_ACCESS_TOKEN="token-value"
#MATRIX_ROOM_ID="myroom"
#MATRIX_SERVER_URL="https://matrix.yourdomain.tld"
#
## https://ntfy.sh or your custom domain with https:// and no trailing /
#NTFY_DOMAIN="https://ntfy.sh"
#NTFY_TOPIC_NAME="YourUniqueTopicName"
#NTFY_AUTH=""   # set to either format -> "user:password" OR ":tk_12345678". If using tokens, don't forget the ":"
#
#PUSHBULLET_URL="https://api.pushbullet.com/v2/pushes"
#PUSHBULLET_TOKEN="token-value"
#
#PUSHOVER_URL="https://api.pushover.net/1/messages.json"
#PUSHOVER_USER_KEY="userkey"
#PUSHOVER_TOKEN="token-value"
#
#SLACK_CHANNEL_ID=mychannel
#SLACK_ACCESS_TOKEN=xoxb-token-value
#
#SMTP_MAIL_FROM="me@mydomain.tld"
#SMTP_MAIL_TO="you@yourdomain.tld"
#SMTP_SUBJECT_TAG="podcheck"
#
#TELEGRAM_CHAT_ID="mychatid"
#TELEGRAM_TOKEN="token-value"
#TELEGRAM_TOPIC_ID="0"
#
#FILE_PATH="${ScriptWorkDir}/updates_available.txt"