docs: add config.example.yml; slim default config.yml to htpasswd#318
Open
allamiro wants to merge 1 commit into
Open
docs: add config.example.yml; slim default config.yml to htpasswd#318allamiro wants to merge 1 commit into
allamiro wants to merge 1 commit into
Conversation
config.example.yml is a copy-and-edit reference showing all backends with realistic, testable values: - LDAP section pre-filled with the docker-compose OpenLDAP test values (uri, base_dn, bind, filter match .env.example exactly) - OIDC section pre-filled with the Keycloak test values (issuer, client_id, client_secret match tests/keycloak/realm.json and .env.example) - All options documented inline with context and caveats config.yml is now a minimal htpasswd configuration. LDAP and OIDC sections are removed; a header comment points to config.example.yml for other backends. The file works out of the box once a .htpasswd file is created. Fixes lixmal#317
allamiro
force-pushed
the
upstream/feat-config-example-file
branch
from
47730e5 to
36b49b3
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.
Fixes #317
Summary
config.example.yml(new) — copy-and-edit reference showing all backends with realistic, testable values:ldap://openldap:1389,ou=users,dc=example,dc=org, admin credentials matching.env.example)tests/keycloak/realm.jsonand.env.example(http://keycloak:8080/realms/keepass, clientkeepass4web, secretinsecure-example-client-secret)cookie_samesite: laxcaveat for OIDCconfig.yml— stripped to a minimal htpasswd configuration. LDAP and OIDC sections removed. Header comment points users toconfig.example.ymlfor other backends.Effect
Users enabling a docker-compose auth service now have a one-stop reference: copy the matching section from
config.example.ymlintoconfig.ymland it works immediately.