Skip to content

docs: add missing runtime configuration keys to env table #816

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

Open
dee-john wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add missing runtime configuration keys to env table #816

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
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The application uses environment variables for configuration. Copy `.env.example
### Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| :--- | :--- | :--- |
| `DATABASE_URL` | PostgreSQL connection string | Required |
| `PORT` | Server port | 3000 |
| `NODE_ENV` | Environment mode | development |
Expand All @@ -112,6 +112,11 @@ The application uses environment variables for configuration. Copy `.env.example
| `JWT_REFRESH_EXPIRES_IN` | Refresh token expiration | 7d |
| `BCRYPT_ROUNDS` | Password hashing rounds | 12 |
| `PASSWORD_HISTORY_LIMIT` | Password history limit | 5 |
| `RECAPTCHA_SECRET` | Private API secret key for Google reCAPTCHA validation | Required |
| `CAPTCHA_THRESHOLD` | Minimum score required to pass reCAPTCHA v3 verification | 0.5 |
| `BASE_URL` | The root domain URL of this running API server instance | http://localhost:3000 |
| `AVATAR_UPLOAD_DIR` | Local disk directory path for saving user profile avatars | ./uploads/avatars |
| `CORS_ORIGINS` | Comma-separated list of allowed cross-origin request sources | http://localhost:3000 |

## 🗄️ Database Setup

Expand Down
Loading