Repository navigation
A single-page reference of the configuration keys read by the core modules and the reference webapp. - #248
Merged
Conversation
…webapp docs/overview/configuration.md lists every configuration key read by src/ and webapp-jakarta/ with its default, and the traps (blank values, trimming, silently skipped formats). Community modules are not covered. CONTRIBUTING.md and the changelog say a PR that changes a key is expected to update the page. Related changes found while checking the keys against the code: - servers=a, b is trimmed like every other list key (it used to fail startup with a NullPointerException) - the PostGIS source no longer reads id.alias, geometry.alias and properties.<p>.alias. They were a not-working and unfinished idea: properties.<p>.alias made startup fail with a NullPointerException - the example configs no longer set writeNulls and geometry.storageSrid, which nothing reads; addresses_view declares its storage SRID with srid.storage
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
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.
Should fix #192. A single-page reference of the configuration keys read by the core modules and the reference webapp.
docs/overview/configuration.mdsrc/andwebapp-jakarta/, with default, whether it is required, and a short description, grouped as the config is: service, collections, properties and columns, databasessrc-community/: tiles, smile, esbulk) are not covered; their READMEs are the referenceCONTRIBUTING.mdand the changelog say a PR that changes a key is expected to update the pageFew functional changes noticed when documenting this stuff:
servers=a, bis now trimmed like every other list key; before, it failed startup with aNullPointerException(one line inHakunaConfigParser.readServers, with a test)collections.<id>.id.alias,geometry.aliasandproperties.<p>.alias. They were a not-working and unfinished idea (properties.<p>.aliasmade startup fail with aNullPointerException). The keys are now ignored;ColumnAliasis replaced by a plain set of column names, as in the GPKG sourcedocker/cfg: the example configs no longer setcollections.<id>.writeNullsandgeometry.storageSrid, which nothing reads.addresses_viewdeclares its storage SRID withsrid.storageinstead