Skip to content

Commit 2039149

Browse files
committed
docs: add readme
1 parent 49cf7e2 commit 2039149

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

Diff for: README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# jwks-federation-server
2+
3+
A simple service which serves a JWKS endpoint containing public keys which are fetched from multiple upstream sources.
4+
5+
## Usage
6+
7+
Create a config file named `config.yaml` based on the sample `config.sample.yaml` file. Next, update `jwks_urls` and optionally limit the keys which gets import from upstream JWKS URLs by defining `allowed_kids`.
8+
9+
```sh
10+
# start container
11+
podman run -d -p 8080:8080 -v $PWD/config.yaml:/config.yaml:ro ghcr.io/nimbolus/jwks-federation-server
12+
# sample request
13+
curl localhost:8080/.well-known/jwks.json
14+
```

Diff for: config.sample.yaml

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,4 @@ update_interval: 1h
33
jwks_urls:
44
- https://vault.example.com/v1/identity/oidc/.well-known/keys
55
- https://keycloak.example.com/realms/master/protocol/openid-connect/certs
6-
allowed_kids:
7-
- 443ec592-bdc2-49dd-abc0-c2faedc6dcda
8-
- 63178a29-0382-4180-906a-9d86609645ca
6+
allowed_kids: []

0 commit comments

Comments
 (0)