diff options
| author | Frédéric Guillot <fred@kanboard.net> | 2014-10-26 19:58:47 -0400 |
|---|---|---|
| committer | Frédéric Guillot <fred@kanboard.net> | 2014-10-26 19:58:47 -0400 |
| commit | d97e1bd4cfd013b54e72f446a0e5934fff559781 (patch) | |
| tree | 81ea919a3b12d61f4b8cd8da5531e380a6810779 /docs/github-authentication.markdown | |
| parent | c5f59f8c8fc4cea247948c2a57cf8074677121e9 (diff) | |
Update documentation
Diffstat (limited to 'docs/github-authentication.markdown')
| -rw-r--r-- | docs/github-authentication.markdown | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/docs/github-authentication.markdown b/docs/github-authentication.markdown index ef99bb80..d6c1e1e8 100644 --- a/docs/github-authentication.markdown +++ b/docs/github-authentication.markdown @@ -9,7 +9,9 @@ Requirements How does this work?
-------------------
-The GitHub authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) protocol, so any user of Kanboard can be linked to a GitHub account. When that is done, they no longer need to manually login with their Kanboard account, but can simply automatically login with their GitHub account.
+The GitHub authentication in Kanboard uses the [OAuth 2.0](http://oauth.net/2/) protocol, so any user of Kanboard can be linked to a GitHub account.
+
+When that is done, they no longer need to manually login with their Kanboard account, but can simply automatically login with their GitHub account.
How to link a GitHub account
----------------------------------
@@ -26,16 +28,16 @@ Installation instructions ### Setting up OAuth 2.0
-If you know what you're doing, you can directly go to the ["Register a new OAuth application"](https://github.com/settings/applications/new) site, set everything up and skip to [Setting up Kanboard](#setting-up-kanboard) below.
+On Github, go to the page ["Register a new OAuth application"](https://github.com/settings/applications/new).
-Summarizing the [official GitHub documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app):
+Just follow the [official GitHub documentation](https://developer.github.com/guides/basics-of-authentication/#registering-your-app):
-- Open your [**Settings**](https://github.com/settings), select [**Applications**](https://github.com/settings/applications) from the sidebar and click on [**Register new application**](https://github.com/settings/applications/new) on the top, next to where it says **Developer applications**
-- Fill out the form with whatever values you like, only the **Authorization callback URL** _must_ be: **http://YOUR_SERVER/?controller=user&action=gitHub**
+- Open your [Settings](https://github.com/settings), select [Applications](https://github.com/settings/applications) from the sidebar and click on [Register new application](https://github.com/settings/applications/new) on the top, next to where it says **Developer applications**
+- Fill out the form with whatever values you like, the **Authorization callback URL** _must_ be: **http://YOUR_SERVER/?controller=user&action=gitHub**
### Setting up Kanboard
-Either create a new `config.php` file or copy and rename the `config.default.php` file and set the following values:
+Either create a new `config.php` file or rename the `config.default.php` file and set the following values:
```php
// Enable/disable GitHub authentication
|