nikdoof/simple-webfinger
1
0
Fork 0
mirror of https://github.com/nikdoof/simple-webfinger.git synced 2025-12-10 17:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Andrew Williams
2024-08-18 21:49:58 +01:00
parent 017e593163
commit 30d5e40520
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -4,9 +4,19 @@ A simple, Flask-based webfinger handler.
Simple Webfinger was created to provide an OIDC href from a basic YAML configuration file. Ideally for use with Tailscale and Authentik.
## Configuration
## Running the application.
The `example-config.yaml` has the basic layout of the YAML file, which has the following fields. This should be provided as `config.yaml` in the working directory you're running the process.
`simple_webfinger` is a basic Flask application and can be configured via environment variables.
| Environment Variable | Description |
| ------------------------------ | ----------------------------------- |
| `SIMPLE_WEBFINGER_CONFIG_FILE` | Path to the YAML configuration file |
## Configuration File
The `examples/example-config.yaml` file has the basic layout of the YAML configuratio, The path to the file should be provided in the environment variable `SIMPLE_WEBFINGER_CONFIG_FILE`.
### Global Values
| Key | Value Example | Description |
| ----------- | --------------------------- | ------------------------------------------------------------- |