feat: add docker-compose configuration for evolution-api, redis, and postgres services#2527
Open
Jubilio wants to merge 1 commit intoEvolutionAPI:mainfrom
Open
feat: add docker-compose configuration for evolution-api, redis, and postgres services#2527Jubilio wants to merge 1 commit intoEvolutionAPI:mainfrom
Jubilio wants to merge 1 commit intoEvolutionAPI:mainfrom
Conversation
…postgres services
Contributor
Reviewer's GuideAdds a new docker-compose configuration to run the evolution API alongside Redis and Postgres using a shared bridge network and .env-based configuration. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Hey - I've found 3 issues, and left some high level feedback:
- Consider moving the hard-coded Postgres credentials (especially POSTGRES_PASSWORD) into the .env file so sensitive values are not committed in the compose file.
- You may want to add named volumes for Postgres (and possibly Redis) to ensure data persists across container restarts instead of relying solely on ephemeral container storage.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider moving the hard-coded Postgres credentials (especially POSTGRES_PASSWORD) into the .env file so sensitive values are not committed in the compose file.
- You may want to add named volumes for Postgres (and possibly Redis) to ensure data persists across container restarts instead of relying solely on ephemeral container storage.
## Individual Comments
### Comment 1
<location path="docker-compose.mwanga.yaml" line_range="4-13" />
<code_context>
+services:
+ api:
+ container_name: evolution_api
+ image: evoapicloud/evolution-api:latest
+ restart: always
+ depends_on:
+ - redis
+ - evolution_postgres
+ ports:
+ - "8080:8080"
+ env_file:
+ - .env
+ networks:
+ - evolution-net
+
+ redis:
+ container_name: evolution_redis
+ image: redis:latest
+ restart: always
+ networks:
</code_context>
<issue_to_address>
**suggestion:** Using `latest` tags for images can make deployments non-reproducible and harder to debug.
For both `api` and `redis`, please pin images to specific versions or digests (e.g. `evoapicloud/evolution-api:1.2.3`, `redis:7.2`) so updates are explicit and controlled.
Suggested implementation:
```
image: evoapicloud/evolution-api:1.2.3
```
```
image: redis:7.2
```
</issue_to_address>
### Comment 2
<location path="docker-compose.mwanga.yaml" line_range="32" />
<code_context>
+ environment:
+ - POSTGRES_DB=evolution_db
+ - POSTGRES_USER=postgres
+ - POSTGRES_PASSWORD=postgres_pass
+ networks:
+ - evolution-net
</code_context>
<issue_to_address>
**🚨 issue (security):** Hard-coding the database password in the compose file is a security risk.
Even for local use, embedding `POSTGRES_PASSWORD` in the compose file makes it easy to leak via version control or shared configs. Since you already use `.env`, reference the variable instead (e.g., `POSTGRES_PASSWORD=${POSTGRES_PASSWORD}`) and keep the actual secret only in `.env` or your secrets manager.
</issue_to_address>
### Comment 3
<location path="docker-compose.mwanga.yaml" line_range="23-13" />
<code_context>
+ networks:
+ - evolution-net
+
+ evolution_postgres:
+ container_name: evolution_postgres
+ image: postgres:15
+ restart: always
+ env_file:
+ - .env
+ environment:
+ - POSTGRES_DB=evolution_db
+ - POSTGRES_USER=postgres
+ - POSTGRES_PASSWORD=postgres_pass
+ networks:
+ - evolution-net
+
</code_context>
<issue_to_address>
**suggestion (bug_risk):** Lack of a volume for Postgres means database data will be lost when the container is removed.
If this is meant for more than disposable local testing, define a named volume for `evolution_postgres` (e.g. `volumes: [evolution_postgres_data:/var/lib/postgresql/data]`) so data persists across container recreations and `docker-compose down` runs.
Suggested implementation:
```
evolution_postgres:
container_name: evolution_postgres
image: postgres:15
volumes:
- evolution_postgres_data:/var/lib/postgresql/data
```
You also need to declare the named volume `evolution_postgres_data` at the top level of the compose file, for example:
```yaml
volumes:
evolution_postgres_data:
```
Place this alongside the existing top-level `services:` / `networks:` keys (not nested under a service). If there is already a `volumes:` section, just add `evolution_postgres_data:` under it instead of creating a new `volumes:` key.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+4
to
+13
| image: evoapicloud/evolution-api:latest | ||
| restart: always | ||
| depends_on: | ||
| - redis | ||
| - evolution_postgres | ||
| ports: | ||
| - "8080:8080" | ||
| env_file: | ||
| - .env | ||
| networks: |
Contributor
There was a problem hiding this comment.
suggestion: Using latest tags for images can make deployments non-reproducible and harder to debug.
For both api and redis, please pin images to specific versions or digests (e.g. evoapicloud/evolution-api:1.2.3, redis:7.2) so updates are explicit and controlled.
Suggested implementation:
image: evoapicloud/evolution-api:1.2.3
image: redis:7.2
| environment: | ||
| - POSTGRES_DB=evolution_db | ||
| - POSTGRES_USER=postgres | ||
| - POSTGRES_PASSWORD=postgres_pass |
Contributor
There was a problem hiding this comment.
🚨 issue (security): Hard-coding the database password in the compose file is a security risk.
Even for local use, embedding POSTGRES_PASSWORD in the compose file makes it easy to leak via version control or shared configs. Since you already use .env, reference the variable instead (e.g., POSTGRES_PASSWORD=${POSTGRES_PASSWORD}) and keep the actual secret only in .env or your secrets manager.
| - "8080:8080" | ||
| env_file: | ||
| - .env | ||
| networks: |
Contributor
There was a problem hiding this comment.
suggestion (bug_risk): Lack of a volume for Postgres means database data will be lost when the container is removed.
If this is meant for more than disposable local testing, define a named volume for evolution_postgres (e.g. volumes: [evolution_postgres_data:/var/lib/postgresql/data]) so data persists across container recreations and docker-compose down runs.
Suggested implementation:
evolution_postgres:
container_name: evolution_postgres
image: postgres:15
volumes:
- evolution_postgres_data:/var/lib/postgresql/data
You also need to declare the named volume evolution_postgres_data at the top level of the compose file, for example:
volumes:
evolution_postgres_data:Place this alongside the existing top-level services: / networks: keys (not nested under a service). If there is already a volumes: section, just add evolution_postgres_data: under it instead of creating a new volumes: key.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Deployment: