Skip to content

Fixed Docker custom ports and updated docs#158

Merged
therealbrad merged 4 commits intoTestPlanIt:mainfrom
clFaster:bugfix/docker-compose
Mar 27, 2026
Merged

Fixed Docker custom ports and updated docs#158
therealbrad merged 4 commits intoTestPlanIt:mainfrom
clFaster:bugfix/docker-compose

Conversation

@clFaster
Copy link
Copy Markdown
Contributor

Description

  • You can override host-exposed Docker ports using the DOCKER_*_PORT variables used in compose files (for example DOCKER_POSTGRES_PORT).
  • Can be set as environment var in .env file or passed with --env-file

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • Refactoring (no functional changes)
  • Performance improvement

How Has This Been Tested?

Describe the tests you ran to verify your changes:

  • Unit tests
  • Integration tests
  • E2E tests
  • Manual testing

Test Configuration:

  • OS: Windows 11
  • Browser (if applicable): -
  • Node version: v24.13.0

Checklist

  • My code follows the project's style guidelines
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published
  • I have signed the CLA

Additional Notes

This change makes it easier to run multiple instances on the same machine by allowing port overrides through environment variables, without editing files that are committed to Git.

@clFaster
Copy link
Copy Markdown
Contributor Author

I noticed the docs almost exclusivly describe the profile-based workflow, but the repo still includes multiple Compose files.
Are those extra Compose files still supported for dev/prod, or are they legacy?

@therealbrad
Copy link
Copy Markdown
Contributor

Both profiles and those compose files are supported. docker-compose.yml is the all-in-one file for quick setup (dev/prod profiles). The standalone docker-compose.dev.yml and docker-compose.prod.yml are used for deployments where you need finer control over which infrastructure services run in Docker vs. externally.

I found myself setting up a single PostgreSQL DB and MinIO instance for all my local deployments while developing, but wanting to run the other services inside their own docker container to keep the data separate so I thought both ways were useful.

Copy link
Copy Markdown
Contributor

@therealbrad therealbrad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would help others to add the custom port options as comments in the .env.example file. Not completely necessary, though.

@clFaster
Copy link
Copy Markdown
Contributor Author

I found myself setting up a single PostgreSQL DB and MinIO instance for all my local deployments while developing, but wanting to run the other services inside their own docker container to keep the data separate so I thought both ways were useful.

I see, thanks!

I think it would help others to add the custom port options as comments in the .env.example file. Not completely necessary, though.

I've added it there, with explaination how to use. Wasn't sure if it isn't confusing that they are not applied with

env_file:
  - .env.development # Load development environment variables

@therealbrad therealbrad merged commit 8f355e0 into TestPlanIt:main Mar 27, 2026
1 check passed
@therealbrad
Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.18.9 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

clFaster pushed a commit to clFaster/testplanit that referenced this pull request Mar 27, 2026
## [0.18.9](TestPlanIt/testplanit@v0.18.8...v0.18.9) (2026-03-27)

### Bug Fixes

* Fixed Docker custom ports and updated docs ([TestPlanIt#158](TestPlanIt#158)) ([8f355e0](TestPlanIt@8f355e0))
@clFaster clFaster deleted the bugfix/docker-compose branch March 28, 2026 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants