summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-03-05 13:06:06 -0700
committermo khan <mo@mokhan.ca>2025-03-05 13:06:06 -0700
commit8e8b719126c2602780ee49fc684a5e095f3926f6 (patch)
tree256003af47aa3d14ff9febf3ed906679fade049e /README.md
parente1fe97ff76ac966039347465f79dc96e705f7f25 (diff)
docs: update the README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0217ebce..43fc3fe3 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,27 @@ Below is a recording of a SAML based service provider initiated login, displayin
![SAML Login](./screencast.webm)
+## Getting Started
+
+1. Install tools:
+ ```sh
+ $ mise install
+ ```
+1. Add entries to `/etc/hosts`:
+ ```sh
+ $ tail -n3 /etc/hosts
+ 127.0.0.1 api.example.com
+ 127.0.0.1 idp.example.com
+ 127.0.0.1 ui.example.com
+ ```
+1. Start servers:
+ ```sh
+ $ mage
+ ```
+1. Open browser to `http://ui.example.com:8080/saml/new` to start a new SAML
+ session. Or open `http://ui.example.com:8080/oidc/new` to start a new OIDC
+ session.
+
## Experiments
### Twirp + gRPC (AuthZ)