Ship one example configuration - #121
Merged
Merged
Conversation
- Delete examples/dims.conf. - Drop it from the shipped configuration check.
beetlebugorg
force-pushed
the
chore/single-example-config
branch
from
September 1, 2026 03:31
ed78a7b to
6395eda
Compare
beetlebugorg
changed the title
The example set images.example.com and *.cdn.example.com. An operator sets the hosts their own deployment fetches from.
beetlebugorg
force-pushed
the
chore/single-example-config
branch
from
September 1, 2026 11:15
6395eda to
544723e
Compare
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.
What
conf/mod_dims.conf.exampleis the only example configuration. Its allowlist is commented out.Why
Two example configurations described different servers.
conf/mod_dims.conf.exampleis the file the build installs, the filedocs/docs/configuration/index.mdnames, and the fileExampleConfigIsValidparses against httpd. It sets/dims5/,DimsSigningKey,DimsMaxSourceBytes,DimsAllowPrivateAddresses,DimsAllowlistSigned, andDimsStatusVerbose.examples/dims.confdates to 2009 and last changed in 2012. It setplacehold.itand*.aolcdn.comas its hosts, and it set none of the directives above. The build did not install it.ShippedConfigLoadsTheModuleread it for one line,LoadModule.AddHandler dims-localappeared only in that file.docs/docs/endpoints/local.mddocuments the handler.The allowlist set
images.example.comand*.cdn.example.com. An operator sets the hosts their own deployment fetches from.Verify
278 cases pass, including
ShippedConfigLoadsTheModule,ModuleLoadsIntoHttpd, andExampleConfigIsValid.Breaking
The build did not install
examples/dims.conf. The example configuration is a template a reader copies and edits.