Repository navigation
feat: add .env.example with env var documentation (Issue #3) - #5
Conversation
- Add health check for db using pg_isready (interval: 10s, timeout: 5s, retries: 5, start_period: 30s) - Add health check for backend using actuator/health endpoint (interval: 15s, timeout: 5s, retries: 3, start_period: 60s) - Add health check for frontend using curl on port 80 (interval: 15s, timeout: 5s, retries: 3, start_period: 30s) - Update depends_on to use condition: service_healthy for ordered startup Closes #1
|
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | |
|---|---|---|---|---|---|
| 14784426 | Triggered | Generic High Entropy Secret | 5318b80 | .env.example | View secret |
| 34427002 | Triggered | Generic Password | 5318b80 | .env.example | View secret |
| 14784427 | Triggered | Generic Password | 5318b80 | .env.example | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
There was a problem hiding this comment.
Pull request overview
This PR introduces a repository-level .env.example intended to document environment variables for local/deployed runs, and updates docker-compose.yml to use healthchecks and depends_on health conditions to improve startup ordering.
Changes:
- Added
.env.exampledocumenting DB and Spring-related environment variables. - Updated
docker-compose.ymlto gatefrontend/backendstartup on dependent services being healthy. - Added healthchecks for
backend,frontend, anddbservices.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docker-compose.yml |
Adds healthchecks and switches depends_on to service_healthy conditions for improved orchestration. |
.env.example |
Adds an example env file documenting required environment variables (but currently includes real-looking secrets). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| POSTGRES_USER=table-2-taste | ||
| POSTGRES_PASSWORD=SCbK9nkVHcgjLS | ||
| POSTGRES_DB=table2taste |
| JWT_SECRET=5ee9b307d37af03d6081d53f0ab8756b9d38b00f61a125525531e1b436b0f66d | ||
| JWT_EXPIRATION_MS=3600000 | ||
| TABLE_PASSWORD=xgEne4Kq |
| @@ -0,0 +1,15 @@ | |||
| # Database | |||
Descripción\nAgrega archivo
.env.examplecon documentación de todas las variables de entorno necesarias.Cambios
table2taste/.env.examplecon variables para DB, backend Spring y entornoVariables documentadas
POSTGRES_USER,POSTGRES_PASSWORD,POSTGRES_DBDB_URL,JWT_SECRET,JWT_EXPIRATION_MSTABLE_PASSWORD,DEFAULT_LANGUAGE,FILE_PATHSPRING_PROFILES_ACTIVECloses #3