diff --git a/README.md b/README.md index 8b13789..a4a3658 100644 --- 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 +``` \ No newline at end of file