Configuration

Configuration File [TOML]

Note: config-rs can support a variety of formats. Below is an example of a TOML configuration file. However, going forward only yaml, and helm values files will be tested.

Slackwatch supports configuration via a TOML file. The default location is ~/.slackwatch/config.toml. Here's an example:

System Configuration

[system]
schedule = "0 0 9-22/2 * * *"
data_dir = "/app/slackwatch/data"

schedule

default: 0 0 9-22/2 * * *

description: The schedule is a cron expression that defines when slackwatch should run. The default value is every 2 hours between 9am and 10pm.

data_dir

default: ~/.slackwatch/data

description: The data_dir is the directory where slackwatch stores its data. This includes the state of the last run, and any other data that slackwatch needs to persist.

Notifications Configuration

[notifications.ntfy]
url = "http://localhost:9090"
topic = "slackwatch"
priorty = 1
reminder = "24h"
token = "dummy"

url

value: url(None)

description: the url of your ntfy server.

topic

value: string(None)

default: slackwatch

description: Topic to publish the notification to.

priority

value: int(1)

default: 1

description: Priority of the notification.

reminder

value: string

default: 24h

description: How often to resend the notification. 24h means every 24 hours.

description: This is set to only prevent failure when the token is not set. In deployed scenarios you should set an environment variable named SLACKWATCH_NOTIFICATIONS.NTFY.TOKEN with the value of the token.

callback_url

value: string (None)

default: null

description: The base URL of the SlackWatch API server. Used to construct callback URLs for ntfy action buttons. This URL must be reachable from the ntfy server. For in-cluster access use the Kubernetes service URL (e.g., http://slackwatch.slackwatch.svc.cluster.local:8080). For external access use the public URL (e.g., https://slackwatch.example.com).

auto_rescan_delay

value: string

default: 5m

description: Duration to wait before automatically re-scanning a workload after an upgrade via ntfy callback. This gives Kubernetes time to pull the new image and roll out the deployment. Use "off" to disable auto-rescan. Examples: "1m", "5m", "10m", "1h", "off".

callback_token

value: string (None)

default: null

description: Secret token used to authenticate ntfy action callback requests. When set, the callback URL includes this token as a query parameter, and the callback endpoint validates it before processing an upgrade. Use a long random string (e.g., openssl rand -hex 32). This is required when SlackWatch is exposed publicly via ingress.

GitOps Configuration

[[gitops]]
name = "fleet-slack-house"
#repository_url = "https://github.com/slackspace-io/slackwatch.git"
repository_url = "https://github.com/slackspace-io/fleet-slack-house.git"
branch = "main"
access_token_env_name = "SLACKWATCH_TOKEN"
commit_message = "Updated by slackwatch"
commit_name = "slackwatch"
commit_email = "slackwatch@slackspace.io"

[[gitops]]
name = "noauth"
repository_url = "https://github.com/slackspace-io/slackwatch.git"
branch = "main"
access_token_env_name = "your_github_access_token_for_repoA"
commit_message = "Updated by slackwatch"
commit_name = "slackwatch"
commit_email = "slackwatch@slackspace.io"

Section Description: The gitops section is an array of configurations. The name field is the key used to identify which gitops configuration to use. This should match the annotation slackwatch.repo on the deployment being watched.

[[gitops]]

Complete configuration file

[system]
schedule = "0 0 9-22/2 * * *"
data_dir = "/app/slackwatch/data"

[notifications.ntfy]
url = "http://localhost:9090"
topic = "slackwatch"
priorty = 1
reminder = "24h"
token = "dummy"


[[gitops]]
name = "fleet-slack-house"
#repository_url = "https://github.com/slackspace-io/slackwatch.git"
repository_url = "https://github.com/slackspace-io/fleet-slack-house.git"
branch = "main"
access_token_env_name = "SLACKWATCH_TOKEN"
commit_message = "Updated by slackwatch"
commit_name = "slackwatch"
commit_email = "slackwatch@slackspace.io"

[[gitops]]
name = "noauth"
repository_url = "https://github.com/slackspace-io/slackwatch.git"
branch = "main"
access_token_env_name = "your_github_access_token_for_repoA"
commit_message = "Updated by slackwatch"
commit_name = "slackwatch"
commit_email = "slackwatch@slackspace.io"

Slackwatch Documentation