axum-oidc/examples/basic/README.md
pfzetto 00136320a9
removed integration test from examples/basic
Integrations tests will be re-implemented on the main-crate.
See #20 and #35.
2025-11-21 13:47:37 +01:00

20 lines
846 B
Markdown

This example is a basic web application to demonstrate the features of the `axum-oidc`-crate.
It has three endpoints:
- `/logout` - Logout of the current session using `OIDC RP-Initiated Logout`.
- `/foo` - A handler that only can be accessed when logged in.
- `/bar` - A handler that can be accessed logged out and logged in. It will greet the user with their name if they are logged in.
# Running the Example
## Dependencies
You will need a running OpenID Connect capable issuer like [Keycloak](https://www.keycloak.org/getting-started/getting-started-docker) and a valid client for the issuer.
## Setup Environment
Create a `.env`-file that contains the following keys:
```
APP_URL=http://127.0.0.1:8080
ISSUER=<your-issuer>
CLIENT_ID=<your-client-id>
CLIENT_SECRET=<your-client-secret>
```
## Run the application
`RUST_LOG=debug cargo run`