Procedure to allow users login with GitHub account

Guides/kanboard.md

@@ -12,10 +12,6 @@ Use script `install-kanboard` in the folder `Install` in this repository.
 
 ## Setup GUI
 
-### GitHub authentication
-
-Use the GitHub authentification plugin.
-
 ### Website domain
 
 In _Settings/Application Settings_.
@@ -39,3 +35,35 @@ Go to the plugins settings (you should be logged as an admin).
 [Signal notification](https://github.com/stratmaster/kanboard-plugin-signal)
 
 [SMS two factor authentication](https://github.com/kanboard/plugin-sms-2fa)
+
+## Setup GitHub authentication
+
+### Install plugin
+
+First install the GitHub authentification plugin.
+
+### Create the application on GitHub
+
+With your _admin_ user account, connect to Kanboard and go to _Settings > Integration_. You should see the GitHub authentication panel with the _Github OAuth callback URL_ already completed.
+
+Now, open a new tab and connect to your GitHub account. Then you have to [register your application to GitHub](https://github.com/settings/applications/new). Fill in the form, and do not forget to put the _Authorization callback URL_ retrieved in Kanboard. Now valid the application creation by clicking on _Register application_.
+
+Now, you have been redirected to another GitHub page with the message _Application successfully created_. You have now access to the _client id_ and the _client secret_. Copy paste these two strings in your first tab, inside the GitHub authentication panel in Kanboard.
+
+Now, your application is registered.
+
+### Create a new user
+
+You can now create remote user accounts to allow your team members to connect with their own GitHub account. Please replace the example user name _DricomDragon_ by the username you want to add.
+
+In Kanboard, go to _Settings > User Management_ and click on _Create a new user_. Type _DricomDragon_ in the username field and check the box _Remote user_. Click on _Save_.
+
+Then, click on the newly created user. In the left side panel, in the _Actions_ category, click on _Edit authentication_. You should see a Github Id field. You have to put the GitHub id yourself. To do so, use the GitHub API [https://api.github.com/users/DricomDragon](https://api.github.com/users/DricomDragon). Put the _id_ in the _GitHub Id_ field. Click on _Save_.
+
+Congratulations ! This user can now connect to Kanboard using his own GitHub account.
+
+### Connect with a GitHub account
+
+In the login page, instead of using the login form, hit the _Login with my GitHub Account_. The first time, the user should give the authorzation to the Kanboard application to access public data. The next time, the user will only need to click the link and will be automatically redirected to Kanboard dashboard.
+
+Beware, sometimes Kanboard can fail. Try again, it should work. ^\_^'