Skip to content

Commit

Permalink
README.md: update configuration list
Browse files Browse the repository at this point in the history
  • Loading branch information
@creachadair
creachadair committed Nov 14, 2024
1 parent ba38bbd commit efc45c8
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,16 @@ environment variables. Those without defaults are required.

Here's the complete table based on the provided Go code:

| Command-line flag | Environment variable | Default value | Description |
| ------------------ | -------------------- | --------------------------------------- | ------------------------------------------------------------------------------------ |
| `-addr` | `JETSTREAM_ADDRESS` | Rotation of all public jetsream servers | The [jetstream](https://github.com/bluesky-social/jetstream) hostname to connect to. |
| `-bsky-handle` | `BSKY_HANDLE` | none | The Bluesky handle of the account that will make API requests. |
| `-bsky-app-password` | `BSKY_APP_PASSWORD` | none | The Bluesky app password for authentication. |
| `-slack-webhook-url` | `SLACK_WEBHOOK_URL` | none | The Slack webhook URL for sending notifications. |
| `-bsky-server-url` | `BSKY_SERVER_URL` | "https://bsky.network" | The Bluesky PDS server to send API requests to URL. |
| `-watch-word` | `WATCH_WORD` | "tailscale" | The word to watch out for; may support multiple words in the future. |

| Command-line flag | Environment variable | Default value | Description |
|----------------------|----------------------|-----------------------------------------|-------------------------------------------------------------------------|
| `-addr` | `JETSTREAM_ADDRESS` | Rotation of all public jetsream servers | The [jetstream][jetstream] hostname to connect to. |
| `-bsky-handle` | `BSKY_HANDLE` | none | The Bluesky handle of the account that will make API requests. |
| `-bsky-app-password` | `BSKY_APP_PASSWORD` | none | The Bluesky app password for authentication. |
| `-slack-webhook-url` | `SLACK_WEBHOOK_URL` | none | The Slack webhook URL for sending notifications. |
| `-bsky-server-url` | `BSKY_SERVER_URL` | "https://bsky.network" | The Bluesky PDS server to send API requests to URL. |
| `-watch-word` | `WATCH_WORD` | "tailscale" | The word to watch out for; may support multiple words in the future. |
| `-secrets-url` | `SECRETS_URL` | none | The address of a [setec][setec] server to fetch secrets from (optional) |
| `-secret-prefix` | `SECRET_PREFIX` | "" | A prefix to prepend to secret names fetched from setec (optional) |

[jetstream]: https://github.com/bluesky-social/jetstream
[setec]: https://github.com/tailscale/setec

0 comments on commit efc45c8

Please sign in to comment.