Update Docker Compose documentation for SERVICE_URL magic environment variables and service naming #368
+24
−9
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
This PR updates the Docker Compose documentation to clarify the usage of Coolify's magic environment variables, specifically the difference between
SERVICE_URL_*
andSERVICE_FQDN_*
, and adds important information about service naming practices.Changes Made
SERVICE_URL_SERVICE
should be preferred for generating URLs for servicesSERVICE_URL_APPWRITE
andSERVICE_FQDN_APPWRITE
:SERVICE_URL_APPWRITE
: 'http://appwrite-vgsco4o.example.com' (full URL with protocol)SERVICE_FQDN_APPWRITE
: appwrite-vgsco4o.example.com (domain only)SERVICE_URL_*
instead ofSERVICE_FQDN_*
for URL generation_
) cannot use ports in environment variables, and recommends using hyphens (-
) insteadFiles Changed
docs/knowledge-base/docker/compose.md
Testing
Context
This update addresses the recent changes in Coolify where
SERVICE_URL_*
environment variables are now the preferred method for generating complete URLs with protocols, whileSERVICE_FQDN_*
variables provide just the domain portion.The service naming guidance addresses issues where services with underscores in their names cannot properly use port specifications in environment variables, as discussed in coollabsio/coolify#6152.