|
|
@@ -15,7 +15,7 @@ simplicity, which means it is most definitely not a one-size-fits-all solution.
|
|
|
If you're planning on dealing with hundreds of thousands of users or complicated
|
|
|
authentication flows, look elsewhere. But, if you want:
|
|
|
|
|
|
-- lightweight (runtime memory usage is less than 20MB, even under moderate load)
|
|
|
+- lightweight (runtime memory usage is less than 20MB, even under moderate load, and CPU usage is minimal)
|
|
|
- simple (single statically-linked executable and minimal supporting files)
|
|
|
- ready to use out of the box (as long as your authentication needs fall into the first 95% of use cases)
|
|
|
- easily configured (configuration is mostly done via CLI, with tab-completion available, and designed for interactive use)
|
|
|
@@ -34,7 +34,8 @@ The general format of a `uidc` invocation runs something like the following:
|
|
|
|
|
|
If a database is not explicitly passed via `--db`, it will default to using a
|
|
|
file called `uidc.db` in the current directory; you can also set the
|
|
|
-environment variable `UIDC_DB` if that's more convenient.
|
|
|
+environment variable `UIDC_DB` if that's more convenient. The database path is
|
|
|
+elided from the following examples for brevity.
|
|
|
|
|
|
#### Initial setup ####
|
|
|
|
|
|
@@ -61,6 +62,13 @@ Finally, create an OIDC client:
|
|
|
$UIDC client create example-client
|
|
|
```
|
|
|
|
|
|
+And then run the server! By default, it listens on port 2114, but that can be
|
|
|
+changed with `--port`.
|
|
|
+
|
|
|
+```shell
|
|
|
+$UIDC server
|
|
|
+```
|
|
|
+
|
|
|
#### RBAC ####
|
|
|
|
|
|
uidc implements a simple role-based authentication schema. it works as follows:
|
