Git Product home page Git Product logo

github-oauth-plugin's Introduction

Jenkins GitHub OAuth Plugin

Overview

The GitHub OAuth plugin provides a means of securing a Jenkins instance by offloading authentication and authorization to GitHub. The plugin authenticates by using a GitHub OAuth Application. It can use multiple authorization strategies for authorizing users. GitHub users are surfaced as Jenkins users for authorization. GitHub organizations and teams are surfaced as Jenkins groups for authorization. This plugin supports GitHub Enterprise.

More comprehensive documentation is listed on the wiki page.

Building the plugin from master

Prerequisites

This plugin was last compiled with the following versions.

  • Ubuntu 16.04.1 LTS
  • Apache Maven 3.3.9
  • Java version: 1.8.0_131, vendor: Oracle Corporation

Newer/older versions may work.

Packaging HPI for Jenkins

To create github-oauth.hpi which is the plugin that would be loaded in Jenkins execute the following command.

mvn clean package

The command assumes both Maven and Java are in your $PATH and that you have $JAVA_HOME set up.

Troubleshooting Installation

After installing per the wiki, the <securityRealm> class should have been updated in your /var/lib/jenkins/config.xml file. The value of <clientID> should agree with what you pasted into the admin UI. If it doesn't or you still can't log in, reset to <securityRealm class="hudson.security.HudsonPrivateSecurityRealm"> and restart Jenkins from the command-line.

github-oauth-plugin's People

Contributors

alexrothenberg avatar apcj avatar apemberton avatar brettlangdon avatar bwalding avatar esteveblanch avatar i386 avatar jcarsique avatar jhoblitt avatar johnou avatar jtnord avatar kohsuke avatar luisfaceira avatar markhu avatar martonsereg avatar mattr- avatar michaelneale avatar mocleiri avatar ohtake avatar orenhe avatar pascalw avatar samrocketman avatar sethrosenblum avatar sirosen avatar sorenisanerd avatar spajus avatar spiffxp avatar suryagaddipati avatar vkravets avatar wadeck avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.