Skip to content

Document backend environment configuration #47

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
jatinS-dev merged 2 commits into from
Apr 28, 2026
Merged

Document backend environment configuration #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6824d9e
Document backend environment configuration
Apr 28, 2026
a84c066
Document database path configuration
Apr 28, 2026
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
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,16 @@ Set these before running the server:
Optional:

- `APP_ENV`: Set to `production` (or `prod`) to enable `Secure` auth cookies.
- `API_BASE_URL`: Public backend base URL used for Jira OAuth callbacks. Defaults to `http://localhost:8080`.
- `DATABASE_PATH`: SQLite database path. Defaults to `./sentinent.db`.
- `FRONTEND_BASE_URL`: Used when generating password reset links. Defaults to `http://localhost:4200`.

Token encryption:

- `TOKEN_ENCRYPTION_KEY`: Secret used to encrypt integration access and refresh tokens. Required when Slack, GitHub, Gmail, or Jira integrations are enabled.

SMTP password reset delivery:

- `SMTP_HOST`: SMTP host used to send password reset emails.
- `SMTP_PORT`: SMTP port used to send password reset emails.
- `SMTP_USERNAME`: SMTP username when the mail server requires authentication.
Expand All @@ -20,11 +29,34 @@ Optional:

Production password reset email delivery requires the SMTP settings above. In non-production environments, the API falls back to returning `reset_url` in the forgot-password response when SMTP is not configured.

Slack integration:

- `SLACK_CLIENT_ID`: Slack OAuth app client ID.
- `SLACK_CLIENT_SECRET`: Slack OAuth app client secret.
- `SLACK_REDIRECT_URI`: Optional override for the Slack OAuth callback URL. Defaults to the current request host plus `/api/integrations/slack/callback`.

GitHub integration:

- `GITHUB_CLIENT_ID`: GitHub OAuth app client ID.
- `GITHUB_CLIENT_SECRET`: GitHub OAuth app client secret.

Gmail integration:

- `GOOGLE_CLIENT_ID`: Google OAuth app client ID.
- `GOOGLE_CLIENT_SECRET`: Google OAuth app client secret.
- `GOOGLE_REDIRECT_URI`: Optional override for the Gmail OAuth callback URL. Defaults to the current request host plus `/api/integrations/gmail/callback`.

Jira integration:

- `JIRA_CLIENT_ID`: Atlassian OAuth app client ID.
- `JIRA_CLIENT_SECRET`: Atlassian OAuth app client secret.

## Example (local development)

```powershell
$env:JWT_SECRET = "replace-with-a-long-random-secret"
$env:CORS_ALLOWED_ORIGINS = "http://localhost:4200"
$env:APP_ENV = "development"
$env:TOKEN_ENCRYPTION_KEY = "replace-with-32-plus-random-characters"
go run .
```
Loading