From 9f2b5531216d5ad655b8762451880ad808b7cd45 Mon Sep 17 00:00:00 2001 From: Andrew Williams Date: Fri, 16 Aug 2024 09:22:59 +0100 Subject: [PATCH] Update example config with notes --- example-config.yaml | 9 --------- examples/example-config.yaml | 16 ++++++++++++++++ 2 files changed, 16 insertions(+), 9 deletions(-) delete mode 100644 example-config.yaml create mode 100644 examples/example-config.yaml diff --git a/example-config.yaml b/example-config.yaml deleted file mode 100644 index 4f6abb4..0000000 --- a/example-config.yaml +++ /dev/null @@ -1,9 +0,0 @@ -domain: doofnet.uk -oidc_href: https://id.doofnet.uk/application/o/tailscale/ - -accounts: - nikdoof: - mastodon: nikdoof@mastodon.incognitus.net - aliases: [] - properties: [] - links: [] \ No newline at end of file diff --git a/examples/example-config.yaml b/examples/example-config.yaml new file mode 100644 index 0000000..e893a7c --- /dev/null +++ b/examples/example-config.yaml @@ -0,0 +1,16 @@ +# The domain that this Webfinger instance should respond to, different domains will 404 +domain: doofnet.uk + +# The URL to use for OIDC hrefs, this should be the endpoint of your IDP system for the OIDC application +# Check the documentation for your solution. +# For Authentik, it'll be the 'OpenID Configuration Issuer' for your Provider +oidc_href: https://id.doofnet.uk/application/o/tailscale/ + +# Accounts to return valid responses for. +accounts: + testaccount: # Extra values do not need to be specified + nikdoof: + mastodon: nikdoof@mastodon.incognitus.net # A valid mastodon account will inject the required links for Mastodon to work correctly + aliases: [] # Aliases for this WebFinger account: https://datatracker.ietf.org/doc/html/rfc7033#section-4.4.2 + properties: [] # https://datatracker.ietf.org/doc/html/rfc7033#section-4.4.3 + links: [] # https://datatracker.ietf.org/doc/html/rfc7033#section-4.4.4 \ No newline at end of file