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

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 of the GoCD server.

# 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:

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:
```
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:
```
$ 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

Copyright 2019 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.