Skip to content

fix: Standardize webhook secret configuration across documentation #9

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

Merged
neil-pozetroninc merged 1 commit into from
Oct 23, 2025
Merged

fix: Standardize webhook secret configuration across documentation #9

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
PROBOTSHARP_GITHUB_APPID=123456

# Webhook secret for validating webhook payloads
PROBOTSHARP_GITHUB_WEBHOOKSECRET=your-webhook-secret-here
PROBOTSHARP_WEBHOOK_SECRET=your-webhook-secret-here

# GitHub App Private Key - use one of these methods:
# Option 1: Path to private key file (mounted as volume in docker-compose.yml)
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ services:
- ASPNETCORE_URLS=http://+:8080
- ConnectionStrings__ProbotSharp=Host=postgres;Port=5432;Database=${POSTGRES_DB:-probotsharp};Username=${POSTGRES_USER:-probotsharp};Password=${POSTGRES_PASSWORD:-dev-password}
- ProbotSharp__GitHub__AppId=${PROBOTSHARP_GITHUB_APPID}
- ProbotSharp__GitHub__WebhookSecret=${PROBOTSHARP_GITHUB_WEBHOOKSECRET:-development}
- ProbotSharp__GitHub__WebhookSecret=${PROBOTSHARP_WEBHOOK_SECRET:-development}
- ProbotSharp__GitHub__PrivateKey=${PROBOTSHARP_GITHUB_PRIVATEKEY}
- ProbotSharp__GitHub__ClientId=${PROBOTSHARP_GITHUB_CLIENTID:-}
- ProbotSharp__GitHub__ClientSecret=${PROBOTSHARP_GITHUB_CLIENTSECRET:-}
Expand Down
4 changes: 2 additions & 2 deletions docs/Operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ curl -i https://api.github.com/app \
**Resolution:**
```bash
# Verify webhook secret is set
echo $PROBOTSHARP_GITHUB_WEBHOOKSECRET
echo $PROBOTSHARP_WEBHOOK_SECRET

# Test webhook locally with smee.io
docker-compose --profile smee up
Expand Down Expand Up @@ -998,7 +998,7 @@ cp .env.example .env

# Edit .env with your GitHub App credentials
# - PROBOTSHARP_GITHUB_APPID
# - PROBOTSHARP_GITHUB_WEBHOOKSECRET
# - PROBOTSHARP_WEBHOOK_SECRET
# - PROBOTSHARP_GITHUB_PRIVATEKEY (or mount private-key.pem)

# Start all services
Expand Down
2 changes: 1 addition & 1 deletion examples/TemplateTestBot/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PROBOTSHARP_GITHUB_APPID=123456

# Your GitHub App's webhook secret
# This is used to verify that webhook payloads are from GitHub
PROBOTSHARP_GITHUB_WEBHOOKSECRET=your-webhook-secret-here
PROBOTSHARP_WEBHOOK_SECRET=your-webhook-secret-here

# GitHub App Private Key
# Option 1: Path to private key file (recommended for local development)
Expand Down
4 changes: 2 additions & 2 deletions examples/TemplateTestBot/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A GitHub App built with [ProbotSharp](https://github.com/your-repo/probot-sharp)

Edit `.env` and set:
- `PROBOTSHARP_GITHUB_APPID` - Your GitHub App ID
- `PROBOTSHARP_GITHUB_WEBHOOKSECRET` - Your webhook secret
- `PROBOTSHARP_WEBHOOK_SECRET` - Your webhook secret
- `PROBOTSHARP_GITHUB_PRIVATEKEY` - Path to your private key file or base64-encoded key

2. **Run the bot**
Expand Down Expand Up @@ -159,7 +159,7 @@ All configuration is done through environment variables (or `.env` file). See `.
### Required Configuration

- `PROBOTSHARP_GITHUB_APPID` - Your GitHub App ID
- `PROBOTSHARP_GITHUB_WEBHOOKSECRET` - Webhook secret for signature verification
- `PROBOTSHARP_WEBHOOK_SECRET` - Webhook secret for signature verification
- `PROBOTSHARP_GITHUB_PRIVATEKEY` - Private key (file path or base64-encoded)

### Optional Configuration
Expand Down
2 changes: 1 addition & 1 deletion templates/probotsharp-app/.env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ PROBOTSHARP_GITHUB_APPID=GITHUB_APP_ID

# Your GitHub App's webhook secret
# This is used to verify that webhook payloads are from GitHub
PROBOTSHARP_GITHUB_WEBHOOKSECRET=your-webhook-secret-here
PROBOTSHARP_WEBHOOK_SECRET=your-webhook-secret-here

# GitHub App Private Key
# Option 1: Path to private key file (recommended for local development)
Expand Down
4 changes: 2 additions & 2 deletions templates/probotsharp-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ A GitHub App built with [Probot Sharp](https://github.com/your-repo/probot-sharp

Edit `.env` and set:
- `PROBOTSHARP_GITHUB_APPID` - Your GitHub App ID
- `PROBOTSHARP_GITHUB_WEBHOOKSECRET` - Your webhook secret
- `PROBOTSHARP_WEBHOOK_SECRET` - Your webhook secret
- `PROBOTSHARP_GITHUB_PRIVATEKEY` - Path to your private key file or base64-encoded key

2. **Run the bot**
Expand Down Expand Up @@ -176,7 +176,7 @@ All configuration is done through environment variables (or `.env` file). See `.
### Required Configuration

- `PROBOTSHARP_GITHUB_APPID` - Your GitHub App ID
- `PROBOTSHARP_GITHUB_WEBHOOKSECRET` - Webhook secret for signature verification
- `PROBOTSHARP_WEBHOOK_SECRET` - Webhook secret for signature verification
- `PROBOTSHARP_GITHUB_PRIVATEKEY` - Private key (file path or base64-encoded)

### Optional Configuration
Expand Down
Loading