Update README.md

2023-08-17 22:33:59 +00:00 · 2023-08-17 22:33:59 +00:00 · 16c4090c31
commit 16c4090c31
parent d2aded6022
1 changed files with 23 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1 +1,24 @@
+# keycloak-reg-api

+Simple API for self-registration of Keycloak accounts that use API keys.
+
+## Building
+
+### Local
+
+```
+$ yarn install
+$ export CERC_KCUSERREG_API_URL=http://keycloak:8080/auth
+$ export CERC_KCUSERREG_REG_PW=MySecretKeycloakApiPassword
+$ yarn dev
+```
+
+### Docker
+
+```
+$ docker build -t cerc/keycloak-reg-api:local .
+$ docker run \
+    -e CERC_KCUSERREG_API_URL=http://keycloak:8080/auth \
+    -e CERC_KCUSERREG_REG_PW=MySecretKeycloakApiPassword \
+    -p 9292 cerc/keycloak-reg-api:local
+```