https://github.com/b13/ddev-keycloak
Adds a Keycloak service to ddev
https://github.com/b13/ddev-keycloak
ddev-get
Last synced: 12 months ago
JSON representation
Adds a Keycloak service to ddev
- Host: GitHub
- URL: https://github.com/b13/ddev-keycloak
- Owner: b13
- License: apache-2.0
- Created: 2023-12-25T22:17:57.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T08:12:32.000Z (over 1 year ago)
- Last Synced: 2024-10-25T04:41:06.432Z (over 1 year ago)
- Topics: ddev-get
- Language: Shell
- Homepage:
- Size: 22.5 KB
- Stars: 4
- Watchers: 10
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Keycloak Add-On for DDEV
This DDEV add-on provides a [Keycloak](https://www.keycloak.org/) service for DDEV.
Keycloak is an Open Source Identity Provider and Access Management software.
**It provides ...**
* Single-Sign On
* Identity Brokering and Social Login
* User Federation
* Support for OpenID, SAML and oAuth2
## Why?
If you want to integrate an Identity Provider in your project using
OpenID, SAML or oAuth2 this addon makes it easy to have this provider
installed locally for testing.
In general, you do not have to deal with remote servers that might give you
a hard time to connect to from your local ddev instance. These servers are
mostly buried behind firewalls and other security mechanism.
## Installation
For DDEV v1.23.5 or above run
```bash
ddev add-on get b13/ddev-keycloak && ddev restart
```
For earlier versions of DDEV run
```bash
ddev get b13/ddev-keycloak && ddev restart
```
### Credentials
**Admin - master realm**
User: `admin`
Password: `password`
**Test - ddev realm**
User: `test`
Password: `test`
## Configuration
The configuration is managed using JSON files in `.ddev/keycloak/import`.
Add the JSON files to git, so it can be shared between users.
Import realms and users:
```bash
ddev kcctl import
```
Export realms and users to `.ddev/keycloak/import`:
```bash
ddev kcctl export
```
> [!NOTE]
> The 'master' (default) realm will not be exported as it contains the admin user
> which should not be modified at all.
Delete realms and user ('master' will be recreated):
```bash
ddev kcctl delete
```
## Running the keycloak control script
```
ddev kc --help
```
## Theming
`.ddev/keycloak/themes` includes a basic example for the login theme called `ddev`.
* Theming [docs](https://www.keycloak.org/docs/latest/server_development/index.html#_themes)
* Example [themes](https://github.com/keycloak/keycloak/tree/main/examples/themes/src/main/resources/theme)
**Maintained by [@b13](https://github.com/b13)**