Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs for TLS config variables #3

Merged
merged 1 commit into from
Jul 16, 2024
Merged

docs: add docs for TLS config variables #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ Witness Webhook is configured primarily through a YAML file, with a few environm
| -------- | ------- | ----------- |
| `WITNESS_WEBHOOK_CONFIG_PATH` | `/webhook-config.yaml` | The path to the yaml config file |
| `WITNESS_WEBHOOK_LISTEN_ADDR` | `:8085` | The address the server will listen on |
| `WITNESS_WEBHOOK_ENABLE_TLS` | `false` | If true, witness-webhook will listen with TLS enabled |
| `WITNESS_WEBHOOK_TLS_CERT` | ` ` | Path to the TLS certificate to use |
| `WITNESS_WEBHOOK_TLS_KEY` | ` ` | Path to the TLS key to use |

### YAML Config

Expand Down Expand Up @@ -43,4 +46,4 @@ Currently the available webhook handlers are:

| Option | Default Value | Description |
| ------ | ------------- | ----------- |
| `secret-file-path` | | Path to the file containing the secret used to verify webhooks from Github |
| `secret-file-path` | | Path to the file containing the secret used to verify webhooks from Github |
Loading