summaryrefslogtreecommitdiff
path: root/doc/integration/github.md
diff options
context:
space:
mode:
authorMarin Jankovski <maxlazio@gmail.com>2015-02-13 14:49:19 -0800
committerMarin Jankovski <maxlazio@gmail.com>2015-02-13 14:49:19 -0800
commitd76c5824bc05640d276be96f7853f2d266fd6750 (patch)
treec783924f16e6423e5085d0578b6614c7583b987a /doc/integration/github.md
parentd0f045eb860f819a736d76622d8d9c546a9610ee (diff)
downloadgitlab-ce-d76c5824bc05640d276be96f7853f2d266fd6750.tar.gz
Update oauth documenatation with examples for omnibus package and installations from source.
Diffstat (limited to 'doc/integration/github.md')
-rw-r--r--doc/integration/github.md38
1 files changed, 31 insertions, 7 deletions
diff --git a/doc/integration/github.md b/doc/integration/github.md
index a586334b98d..c9c27859c5e 100644
--- a/doc/integration/github.md
+++ b/doc/integration/github.md
@@ -21,20 +21,44 @@ To enable the GitHub OmniAuth provider you must register your application with G
1. On your GitLab server, open the configuration file.
+ For omnibus package:
+
+ ```sh
+ sudo editor /etc/gitlab/gitlab.rb
+ ```
+
+ For instalations from source:
+
```sh
- cd /home/git/gitlab
+ cd /home/git/gitlab
- sudo -u git -H editor config/gitlab.yml
+ sudo -u git -H editor config/gitlab.yml
```
-1. Find the section dealing with OmniAuth. See [Initial OmniAuth Configuration](README.md#initial-omniauth-configuration) for more details.
+1. See [Initial OmniAuth Configuration](README.md#initial-omniauth-configuration) for inital settings.
+
+1. Add the provider configuration:
+
+ For omnibus package:
+
+ ```ruby
+ gitlab_rails['omniauth_providers'] = [
+ {
+ "name" => "github",
+ "app_id" => "YOUR APP ID",
+ "app_secret" => "YOUR APP SECRET",
+ "url" => "https://github.com/",
+ "args" => { "scope" => "user:email" } }
+ }
+ ]
+ ```
-1. Under `providers:` uncomment (or add) lines that look like the following:
+ For installation from source:
```
- - { name: 'github', app_id: 'YOUR APP ID',
- app_secret: 'YOUR APP SECRET',
- args: { scope: 'user:email' } }
+ - { name: 'github', app_id: 'YOUR APP ID',
+ app_secret: 'YOUR APP SECRET',
+ args: { scope: 'user:email' } }
```
1. Change 'YOUR APP ID' to the client ID from the GitHub application page from step 7.