Compare commits

..

9 Commits

Author SHA1 Message Date
eb5ff04e84 Merge pull request 'Add docs for initial admin user setup' (#20) from docs-n-deprecations into master
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: #20
2025-06-24 12:28:52 +00:00
35461d2f59 Convert bootstrap-admin command to one-liner
Some checks failed
continuous-integration/drone/pr Build is failing
2025-06-22 09:42:20 -04:00
abcc59c07c Add docs for initial admin user setup
Some checks failed
continuous-integration/drone/pr Build is failing
2025-06-21 21:56:35 -04:00
2e863fb666 Fix deprecated traefik labels for TLS 2025-06-21 21:56:23 -04:00
2c77a8fced chore: publish 10.3.1+26.2.5 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-06-18 10:25:17 -07:00
3wc
bd2ec2cd9d chore: publish 10.3.0+26.2.1 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-04-23 18:38:24 +02:00
3wc
7af65faa5a chore: publish 10.2.1+26.1.2 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-02-26 12:46:39 -05:00
3wc
636e81002d Add missing KC_HTTP_ENABLED 2025-02-26 12:46:02 -05:00
3wc
d3c9fc4784 chore: publish 10.2.0+26.1.2 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-02-26 12:27:10 -05:00
2 changed files with 32 additions and 7 deletions

View File

@ -20,11 +20,25 @@
1. Set up Docker Swarm and [`abra`][abra]
2. Deploy [`coop-cloud/traefik`][cc-traefik]
3. `abra app new keycloak --secrets` (optionally with `--pass` if you'd like
to save secrets in `pass`)
to save secrets in `pass`). Make sure to note the `admin_password` which is needed for initial setup.
4. `abra app config YOURAPPDOMAIN` - be sure to change `$DOMAIN` to something that resolves to
your Docker swarm box
5. `abra app deploy YOURAPPDOMAIN`
## Replacing the temporary admin user
When you first deploy Keycloak, you will login in as a temporary admin user with the username "admin" and a random password generated in step 3 above. You need to create a real admin user and delete the temp admin user, because the temp admin user has no 2FA and its password is stored in plain text on the server, which is insecure. Here's how to create the real admin user:
1. Click "Users" then "Add user"
2. For "required user actions", I recommend setting "Configure OTP" and "Update Password" to ensure 2FA is enabled.
3. Set a username, then click "Create"
5. Go to the "Role Mapping" tab and click "Assign role"
6. Change the filter from "Filter by clients" to "Filter by realm roles". Select the box for "role_admin" and click "Assign". This makes the user become an admin.
7. Go to the "Credentials" tab. Click "Set password". Set it to something random and save it for the next step. Leave "Temporary" enabled so the user has to change the password on first login.
8. If this is an admin account for you, then log out and back in as the new admin user and complete the password change and OTP steps. If this is an admin account for someone else, securely send the initial username and password to the user. They must complete the password change and OTP setup when they first log in.
Once at least one real admin user is set up, you should then delete the temporary "admin" user.
## How do I setup a custom theme?
Check [this approach](https://git.autonomic.zone/ruangrupa/login.lumbung.space).
@ -35,6 +49,16 @@ Check [this approach](https://git.autonomic.zone/ruangrupa/login.lumbung.space).
- Create the user and set a temporary password
- Under the `Role Mappings` tab, move `admin` from `Available Roles` into `Assigned Roles`
## What do I do if I lost my admin account credentials?
You can create a new admin account like this:
```
abra app run <domain> app -- bash -c '/opt/keycloak/bin/kc.sh bootstrap-admin user --db-password $(cat /run/secrets/db_password)'
```
Make sure to delete the temp-admin user after you finish recovering.
## How do I configure Keycloak login for..
- [Nextcloud][nextcloud]

View File

@ -3,7 +3,7 @@ version: "3.8"
services:
app:
image: "keycloak/keycloak:26.0.1"
image: "keycloak/keycloak:26.2.5"
entrypoint: >
bash -c "KEYCLOAK_ADMIN_PASSWORD=\"$$(cat /run/secrets/admin_password)\" KC_DB_PASSWORD=\"$$(cat /run/secrets/db_password)\" /opt/keycloak/bin/kc.sh start"
networks:
@ -22,6 +22,7 @@ services:
- KEYCLOAK_ADMIN=${ADMIN_USERNAME}
- KEYCLOAK_WELCOME_THEME=${WELCOME_THEME}
- KC_PROXY_HEADERS=xforwarded
- KC_HTTP_ENABLED=true
# NOTE(3wc): disabled due to missing curl binary, see
# https://git.coopcloud.tech/coop-cloud/keycloak/issues/15
# healthcheck:
@ -45,15 +46,15 @@ services:
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
- "traefik.http.middlewares.${STACK_NAME}-redirect.redirectscheme.scheme=https"
- "traefik.http.middlewares.${STACK_NAME}-redirect.redirectscheme.permanent=true"
- "caddy=${DOMAIN}"
- "caddy.reverse_proxy={{upstreams 8080}}"
- "caddy.tls.on_demand="
- "coop-cloud.${STACK_NAME}.version=10.1.1+26.0.1"
- "coop-cloud.${STACK_NAME}.version=10.3.1+26.2.5"
db:
image: "mariadb:11.5"
image: "mariadb:11.7"
environment:
- MYSQL_DATABASE=keycloak
- MYSQL_USER=keycloak