https://github.com/gocd-contrib/github-oauth-authorization-plugin
https://github.com/gocd-contrib/github-oauth-authorization-plugin
authorization github gocd plugin
Last synced: 10 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gocd-contrib/github-oauth-authorization-plugin
- Owner: gocd-contrib
- License: apache-2.0
- Created: 2017-07-23T07:48:04.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-11-18T06:24:12.000Z (2 months ago)
- Last Synced: 2025-11-18T08:23:14.701Z (2 months ago)
- Topics: authorization, github, gocd, plugin
- Language: Java
- Size: 1.27 MB
- Stars: 11
- Watchers: 6
- Forks: 19
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub OAuth authorization plugin for GoCD
The plugin allows user to login in GoCD using GitHub(or GitHub Enterprise). It also supports authorization, which can be used by server admin to map GoCD roles with GitHub organizations or teams.
# Installation
Documentation for installation is available [here](INSTALL.md)
# Capabilities
* The plugin is implemented using `GoCD plugin authorization endpoint`. Hence, it supports `authentication` and `authorization`.
## Troubleshooting
### Enable Debug Logs
#### If you are on GoCD version 19.6 and above:
Edit the file `wrapper-properties.conf` on your GoCD server and add the following options. The location of the `wrapper-properties.conf` can be found in the [installation documentation](https://docs.gocd.org/current/installation/installing_go_server.html) of the GoCD server.
```properties
# We recommend that you begin with the index `100` and increment the index for each system property
wrapper.java.additional.100=-Dplugin.cd.go.authorization.github.log.level=debug
```
If you're running with GoCD server 19.6 and above on docker using one of the supported GoCD server images, set the environment variable `GOCD_SERVER_JVM_OPTIONS`:
```shell
docker run -e "GOCD_SERVER_JVM_OPTIONS=-Dplugin.cd.go.authorization.github.log.level=debug" ...
```
#### If you are on GoCD version 19.5 and lower:
* On Linux:
Enabling debug level logging can help you troubleshoot an issue with this plugin. To enable debug level logs, edit the file `/etc/default/go-server` (for Linux) to add:
```shell
export GO_SERVER_SYSTEM_PROPERTIES="$GO_SERVER_SYSTEM_PROPERTIES -Dplugin.cd.go.authorization.github.log.level=debug"
```
If you're running the server via `./server.sh` script:
```shell
$ GO_SERVER_SYSTEM_PROPERTIES="-Dplugin.cd.go.authorization.github.log.level=debug" ./server.sh
```
* On windows:
Edit the file `config/wrapper-properties.conf` inside the GoCD Server installation directory (typically `C:\Program Files\Go Server`):
```
# config/wrapper-properties.conf
# since the last "wrapper.java.additional" index is 15, we use the next available index.
wrapper.java.additional.16=-Dplugin.cd.go.authorization.github.log.level=debug
```
## Building the code base
To build the jar, run `./gradlew clean test assemble`
## License
```plain
Copyright 2022 Thoughtworks, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```