debian-mirror-gitlab/doc/integration/gitlab.md

87 lines
2.7 KiB
Markdown
Raw Normal View History

2015-04-26 12:48:37 +05:30
# Integrate your server with GitLab.com
Import projects from GitLab.com and login to your GitLab instance with your GitLab.com account.
2017-08-17 22:00:37 +05:30
To enable the GitLab.com OmniAuth provider you must register your application with GitLab.com.
2015-04-26 12:48:37 +05:30
GitLab.com will generate an application ID and secret key for you to use.
2019-09-30 21:07:59 +05:30
1. Sign in to GitLab.com
2015-04-26 12:48:37 +05:30
2018-11-08 19:23:39 +05:30
1. On the upper right corner, click on your avatar and go to your **Settings**.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Select **Applications** in the left menu.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Provide the required details for **Add new application**.
- Name: This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive.
- Redirect URI:
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
```
http://your-gitlab.example.com/import/gitlab/callback
http://your-gitlab.example.com/users/auth/gitlab/callback
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
The first link is required for the importer and second for the authorization.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Select **Save application**.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. You should now see a **Application Id** and **Secret** near the top right of the page (see screenshot).
Keep this page open as you continue configuration.
![GitLab app](img/gitlab_app.png)
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. On your GitLab server, open the configuration file.
2015-04-26 12:48:37 +05:30
2019-12-04 20:38:33 +05:30
For Omnibus package:
2015-04-26 12:48:37 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-09-30 21:07:59 +05:30
sudo editor /etc/gitlab/gitlab.rb
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
For installations from source:
2015-04-26 12:48:37 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-09-30 21:07:59 +05:30
cd /home/git/gitlab
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
sudo -u git -H editor config/gitlab.yml
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. See [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration) for initial settings.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Add the provider configuration:
2015-04-26 12:48:37 +05:30
2019-12-04 20:38:33 +05:30
For Omnibus package:
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
```ruby
gitlab_rails['omniauth_providers'] = [
{
"name" => "gitlab",
"app_id" => "YOUR_APP_ID",
"app_secret" => "YOUR_APP_SECRET",
"args" => { "scope" => "api" }
}
]
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
For installations from source:
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
```
- { name: 'gitlab', app_id: 'YOUR_APP_ID',
app_secret: 'YOUR_APP_SECRET',
args: { scope: 'api' } }
```
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Change 'YOUR_APP_ID' to the Application ID from the GitLab.com application page.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Change 'YOUR_APP_SECRET' to the secret from the GitLab.com application page.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. Save the configuration file.
2015-04-26 12:48:37 +05:30
2019-09-30 21:07:59 +05:30
1. [Reconfigure][] or [restart GitLab][] for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
On the sign in page there should now be a GitLab.com icon below the regular sign in form.
Click the icon to begin the authentication process. GitLab.com will ask the user to sign in and authorize the GitLab application.
2015-04-26 12:48:37 +05:30
If everything goes well the user will be returned to your GitLab instance and will be signed in.
2017-08-17 22:00:37 +05:30
[reconfigure]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[restart GitLab]: ../administration/restart_gitlab.md#installations-from-source