https://github.com/nikdoof/simple-webfinger
A simple, Flask-based webfinger handler.
https://github.com/nikdoof/simple-webfinger
python webfinger
Last synced: 4 months ago
JSON representation
A simple, Flask-based webfinger handler.
- Host: GitHub
- URL: https://github.com/nikdoof/simple-webfinger
- Owner: nikdoof
- Created: 2023-04-30T16:22:32.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-26T05:30:28.000Z (5 months ago)
- Last Synced: 2026-01-26T19:59:14.886Z (5 months ago)
- Topics: python, webfinger
- Language: Python
- Homepage:
- Size: 589 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Simple Webfinger
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.
## Running the application.
`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 |
| ----------- | --------------------------- | ------------------------------------------------------------- |
| `domain` | `doofnet.uk` | The domain to respond to, it'll return 404s for anything else |
| `oidc_href` | `https://id.doofnet.uk/...` | The href to return for OIDC rels |
### Accounts
Accounts can be defined under the `accounts` key, and a key for each user, for example:
```yaml
accounts:
nikdoof:
mastodon: nikdoof@mastodon.incognitus.net
aliases: []
properties: []
links: []
```
The app will only reply to accounts listed in the configuration, otherwise, it'll return a 404.
| Key | Value Example | Description |
| ------------ | --------------------------------- | --------------------------------------------------------------- |
| `mastodon` | `nikdoof@mastodon.incognitus.net` | A Mastodon account to generate the related links/properties for |
| `aliases` | `[]` | A list of aliases to include in the response for the account |
| `links` | `[]` | A list of dicts to include in the response |
| `properties` | `[]` | A list of dicts to include in the response |