====== oAuthGitHub Plugin ======

---- plugin ----
description: GitHub Service for use with the oAuth Plugin
author     : Andreas Gohr 
email      : dokuwiki@cosmocode.de
type       : action
lastupdate : 2021-12-05
compatible : Hogfather
depends    : oauth
conflicts  : 
similar    : 
tags       : oauth, authentication

downloadurl: https://github.com/cosmocode/dokuwiki-plugin-oauthgithub/zipball/master
bugtracker : https://github.com/cosmocode/dokuwiki-plugin-oauthgithub/issues
sourcerepo : https://github.com/cosmocode/dokuwiki-plugin-oauthgithub/
donationurl: 

screenshot_img :
----

This plugin implements the oAuth workflow needed to authenticate users with Github as Identity Provider.

===== Installation =====
[[https://www.cosmocode.de/en/open-source/dokuwiki-plugins/|{{ http://cosmocode.de/static/img/dokuwiki/dwplugins.png?recache|A CosmoCode Plugin}}]]

:!: **External requirements:** This plugin requires the [[plugin:oauth|oAuth Plugin]].

Install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.


===== Configuration =====

You need to set the Client ID and Secret of your GitHub Authentication application.

  * go to https://github.com/settings/developers
  * click "New OAuth App"
    * Application Name: DokuWiki
    * Homepage URL: //your wiki URL//
    * Application Description:
    * Authorization callback URL: //the redirect URL shown in your wiki's config manager//
  * click "Register Application
  * copy the shown Client ID to your wiki's config manager
  * click "Generate new client secret"
  * copy the shown Client Secret to your wiki's config manager
  * optionally fill in additional data, like a logo

{{https://i.imgur.com/F0qq6rz.png}}

===== Development =====

=== Change Log ===

{{rss>https://github.com/cosmocode/dokuwiki-plugin-oauthgithub/commits/master.atom date}}

=== Known Bugs and Issues ===

Please report bugs and issues at https://github.com/cosmocode/dokuwiki-plugin-oauthgithub/issues