Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/keycloak-plugin
Keycloak Authentication Plugin
https://github.com/jenkinsci/keycloak-plugin
authentication jenkins-plugin jenkins-security-scan-enabled keycloak
Last synced: about 1 month ago
JSON representation
Keycloak Authentication Plugin
- Host: GitHub
- URL: https://github.com/jenkinsci/keycloak-plugin
- Owner: jenkinsci
- License: mit
- Fork: true (devlauer/jenkins-keycloak-plugin)
- Created: 2017-03-28T15:46:21.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-02T19:20:23.000Z (3 months ago)
- Last Synced: 2024-04-09T21:42:50.697Z (3 months ago)
- Topics: authentication, jenkins-plugin, jenkins-security-scan-enabled, keycloak
- Language: Java
- Homepage: https://plugins.jenkins.io/keycloak
- Size: 650 KB
- Stars: 33
- Watchers: 4
- Forks: 22
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- License: LICENSE
Lists
- awesome-keycloak - Jenkins Keycloak Authentication Plugin
README
# Keycloak Plugin
About
---
This plugin incorporates SSO in [Jenkins] with [Keycloak]
Installation
---
1. Within the Jenkins dashboard, click Manage Jenkins.
2. In the Manage Jenkins page, click Manage Plugins.
3. Click the Available tab.
4. Filter for keycloak
5. Click either “Install without restart” or “Download now and install after restart”.
6. Restart Jenkins if necessary.
Usage
---
#### Step 1 : Create a keycloak client in a realm
Lets call the realm **'ci'** and the client **'jenkins'**
Jenkins is running on port **8080**
Create the client accordingly
Also make sure sample users are also created, in this case I have
created 'devlauer'.
#### Step 2 : Copy the keycloak.json
#### Step 3 : In the Jenkins global security settings page select the Keycloak Authentication Plugin for the Security Realm and paste the keycloak JSON content
#### Step 4 : Log in into jenkins
##### Jenkins redirects to keycloak for authentication
##### Keycloak redirects back to Jenkins after successful authentication
License
---
Jenkins-Keycloak-Plugin is **licensed** under the **[MIT License]**.
Versioning
---
This plugin uses sematic versioning. For more information refer to [semver]
Changelog
---
Changes are available on the [GitHub Releases] page
Reporting bugs and feature requests
---
We use the [Jenkins JIRA] to log all bugs and feature requests. Create a [new account], browse to [Jenkins JIRA] and login with your account then create a new issue with the component `keycloak-plugin`.
Source
---
Latest and greatest source of Jenkins Keycloak Plugin can be found on [GitHub]. Fork it!
Building From Source
---
* Checkout or download the source code from the latest tag on [GitHub]
* Execute `mvn clean verify` from your local source code folder (install [Maven] if not already done).
* Find the `keycloak.hpi` file in the `target` subfolder.
Testing The Plugin
---
Execute the following
mvn hpi:run -Djetty.port=8090 -Dhpi.prefix=/jenkins
For more details refer the [official plugin tutorial](https://wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial)
Notice
---
This repository was forked from this [repository](https://www.github.com/devlauer/jenkins-keycloak-plugin), which was originally a fork of this [repository](https://www.github.com/keycloak/jenkins-keycloak-plugin)
[semver]: http://semver.org
[Jenkins]: http://jenkins-ci.org
[Keycloak]: http://keycloak.jboss.org/
[new account]: https://accounts.jenkins.io/
[Jenkins JIRA]: https://issues.jenkins-ci.org/
[official plugin tutorial]: https://wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial
[MIT License]: https://github.com/jenkinsci/keycloak-plugin/raw/master/LICENSE
[Changelog]: https://github.com/jenkinsci/keycloak-plugin/blob/master/Changelog.md
[GitHub]: https://github.com/jenkinsci/keycloak-plugin
[Maven]: http://maven.apache.org
[wiki]: https://wiki.jenkins-ci.org/display/JENKINS/keycloak-plugin
[GitHub Releases]: https://github.com/jenkinsci/keycloak-plugin/releases