https://github.com/thehyve/fairspace-keycloak-configuration
Repository containing scripts for configuration of Fairspace Keycloak
https://github.com/thehyve/fairspace-keycloak-configuration
fairspace
Last synced: 11 months ago
JSON representation
Repository containing scripts for configuration of Fairspace Keycloak
- Host: GitHub
- URL: https://github.com/thehyve/fairspace-keycloak-configuration
- Owner: thehyve
- License: apache-2.0
- Archived: true
- Created: 2018-06-27T13:14:16.000Z (about 8 years ago)
- Default Branch: dev
- Last Pushed: 2021-08-16T10:37:59.000Z (almost 5 years ago)
- Last Synced: 2025-06-11T09:14:53.578Z (about 1 year ago)
- Topics: fairspace
- Language: Shell
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Keycloak configuration scripts
This repository contains configuration scripts to configure
Keycloak when installing a new Fairspace instance.
The scripts are usually executed via helm post-install hooks.
## Keycloak admin api
The configurations scripts make use of the `kcadm.sh` script
that calls the Keycloak Admin API from the command line.
This simplifies the usage of the api a bit. More information can be
found in [the Keycloak admin CLI documentation](https://www.keycloak.org/docs/12.0/server_admin/index.html#the-admin-cli).
The scripts and their dependencies are packaged in a Docker container.
## Local testing
You can test the scripts locally by starting the
docker container and mounting the scripts directory inside.
The following command would do the trick:
```
docker build . --tag keycloak-config
docker run --rm -it -v :/opt/jboss/scripts keycloak-config
```
You can also pass environment variables to work with the scripts easily. For example:
```
docker run --rm -it \
-v :/opt/jboss/scripts \
-v :/opt/jboss/redirect-urls \
-e "KEYCLOAK_USER=keycloak" \
-e "KEYCLOAK_PASSWORD=keycloak" \
-e "KEYCLOAK_URL=http://172.17.0.1:5100/auth" \
keycloak-config
```
That would allow you to run the `setup-keycloak-hyperspace.sh` script as follows:
```
./setup-keycloak-hyperspace.sh $KEYCLOAK_URL $KEYCLOAK_USER
```
Please note that the docker -v command requires the absolute path to the scripts
directory to work properly.
## License
Copyright (c) 2021 The Hyve B.V.
This program is free software: you can redistribute it and/or modify it under the terms of the Apache 2.0
License published by the Apache Software Foundation, either version 2.0 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty
of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache 2.0 License for more details.
You should have received a copy of the Apache 2.0 License along with this program (see [LICENSE](LICENSE)). If not, see https://www.apache.org/licenses/LICENSE-2.0.txt.