Skip to content
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.

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

Make docker-compose.yml configurable #1504

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Make docker-compose.yml configurable #1504

merged 1 commit into from
Jan 8, 2025

Conversation

Oaphi
Copy link
Member

@Oaphi Oaphi commented Jan 5, 2025

This is a minor PR making docker-compose.yml configurable (while still providing an example Compose file & ensuring that it is automatically set up via the local-setup.sh script).

Rationale

While convenient, compose files can differ depending on the users' setup just as much as Dockerfile files (which we've already made configurable). This change allows for greater flexibility while maintaining a good (and tested) default in the spirit of Omakase. Not prescribing a specific Compose file is also standard practice in dockerized projects (see, for example, Pi-hole).

Important note

There is a new Docker-specific environment variable that should be set in the .env file in project root: COMPOSE_FILE (it's a predefined environment variable). If not supplied, compose will use the default docker-compose.yml file from project root, so nothing should break for existing users.

@Oaphi Oaphi added type: configuration Issues caused by incorrect server or app configuration that can be resolved by fixing the config area: deployment Changes to setting up QPixel, Docker, etc. labels Jan 5, 2025
@Oaphi Oaphi requested review from Taeir and ArtOfCode- January 5, 2025 07:22
@Oaphi Oaphi self-assigned this Jan 5, 2025
@Oaphi Oaphi requested a review from a team January 5, 2025 07:23
@Oaphi Oaphi force-pushed the 0valt/compose branch 2 times, most recently from b5e0fe8 to 746246c Compare January 7, 2025 09:09
@Oaphi Oaphi mentioned this pull request Jan 8, 2025
@ArtOfCode- ArtOfCode- merged commit ac3cb2f into develop Jan 8, 2025
7 checks passed
@ArtOfCode- ArtOfCode- deleted the 0valt/compose branch January 8, 2025 09:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: deployment Changes to setting up QPixel, Docker, etc. type: configuration Issues caused by incorrect server or app configuration that can be resolved by fixing the config
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants