diff --git a/README.md b/README.md index 72480bd..dcbfcbd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,43 @@ -# keycloak-dokku +# keycloak -See [gitea-experiment repository](https://gitlab.com/autonomic-cooperative/gitea-experiment) for more. +> https://keycloak.org + +## Setup + +### Pre-requisites + +1. You have SSH access to dokku.autonomic.zone +1. You have sudo privilege escalation working + +``` +Host dokku.autonomic.zone + Hostname dokku.autonomic.zone + User + Port 222 + IdentityFile ~/.ssh/ +``` + +See the password-store under `autonomic-dokku` for your sudo password. + +### Environment + +1. Clone the [infrastructure repository](https://gitlab.com/autonomic-cooperative/infrastructure) +1. Copy the sample file: `cp .envrc.sample .envrc` +1. Ensure that the .envrc `PASSWORD_STORE_DIR` env var points to the `infrastructure/credentials/password-store` + +### Python + +You only need to do this if you're working with Ansible vault (encrypting/decrypting new secrets). + +```bash +$ python3 -m venv .venv +$ source .venv/bin/activate +$ pip install -r requirements.txt +``` + +## Deploy + +```bash +$ git remote add dokku dokku@dokku.autonomic.zone:keycloak +$ git push dokku +``` diff --git a/app.json b/app.json index 8f30a12..39fb62a 100644 --- a/app.json +++ b/app.json @@ -1,5 +1,5 @@ { "name": "keycloak", "description": "Open Source Identity and Access Management", - "repository": "https://gitlab.com/autonomic-cooperative/keycloak-dokku" + "repository": "https://gitlab.com/autonomic-cooperative/coop-cloud/keycloak" }