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

144 lines
5.4 KiB
Markdown
Raw Normal View History

2018-11-18 11:00:15 +05:30
# Integrate your GitLab server with Bitbucket Cloud
2015-04-26 12:48:37 +05:30
2018-11-08 19:23:39 +05:30
NOTE: **Note:**
You need to [enable OmniAuth](omniauth.md) in order to use this.
2016-09-29 09:46:39 +05:30
Import projects from Bitbucket.org and login to your GitLab instance with your
Bitbucket.org account.
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
## Overview
2015-04-26 12:48:37 +05:30
2017-08-17 22:00:37 +05:30
You can set up Bitbucket.org as an OAuth2 provider so that you can use your
2016-09-29 09:46:39 +05:30
credentials to authenticate into GitLab or import your projects from
Bitbucket.org.
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
- To use Bitbucket.org as an OmniAuth provider, follow the [Bitbucket OmniAuth
provider](#bitbucket-omniauth-provider) section.
- To import projects from Bitbucket, follow both the
[Bitbucket OmniAuth provider](#bitbucket-omniauth-provider) and
[Bitbucket project import](#bitbucket-project-import) sections.
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
## Bitbucket OmniAuth provider
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
> **Note:**
2017-08-17 22:00:37 +05:30
GitLab 8.15 significantly simplified the way to integrate Bitbucket.org with
2018-11-18 11:00:15 +05:30
GitLab. You are encouraged to upgrade your GitLab instance if you haven't done so
already. If you're using GitLab 8.14 or below, [use the previous integration
2017-08-17 22:00:37 +05:30
docs][bb-old].
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
To enable the Bitbucket OmniAuth provider you must register your application
with Bitbucket.org. Bitbucket will generate an application ID and secret key for
you to use.
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
1. Sign in to [Bitbucket.org](https://bitbucket.org).
1. Navigate to your individual user settings (**Bitbucket settings**) or a team's
settings (**Manage team**), depending on how you want the application registered.
It does not matter if the application is registered as an individual or a
team, that is entirely up to you.
1. Select **OAuth** in the left menu under "Access Management".
1. Select **Add consumer**.
1. Provide the required details:
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
| Item | Description |
| :--- | :---------- |
| **Name** | This can be anything. Consider something like `<Organization>'s GitLab` or `<Your Name>'s GitLab` or something else descriptive. |
| **Application description** | Fill this in if you wish. |
2019-02-13 22:33:31 +05:30
| **Callback URL** | The URL to your GitLab installation, e.g., `https://gitlab.example.com/users/auth`. |
2016-09-29 09:46:39 +05:30
| **URL** | The URL to your GitLab installation, e.g., `https://gitlab.example.com`. |
2015-04-26 12:48:37 +05:30
2019-02-13 22:33:31 +05:30
NOTE: Be sure to append `/users/auth` to the end of the callback URL
to prevent a [OAuth2 convert
redirect](http://tetraph.com/covert_redirect/) vulnerability.
2017-08-17 22:00:37 +05:30
NOTE: Starting in GitLab 8.15, you MUST specify a callback URL, or you will
see an "Invalid redirect_uri" message. For more details, see [the
Bitbucket documentation](https://confluence.atlassian.com/bitbucket/oauth-faq-338365710.html).
2016-09-29 09:46:39 +05:30
And grant at least the following permissions:
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
```
2017-08-17 22:00:37 +05:30
Account: Email, Read
2019-02-13 22:33:31 +05:30
Projects: Read
2017-08-17 22:00:37 +05:30
Repositories: Read
Pull Requests: Read
Issues: Read
Wiki: Read and Write
2015-04-26 12:48:37 +05:30
```
2016-09-29 09:46:39 +05:30
![Bitbucket OAuth settings page](img/bitbucket_oauth_settings_page.png)
1. Select **Save**.
1. Select your newly created OAuth consumer and you should now see a Key and
2018-11-18 11:00:15 +05:30
Secret in the list of OAuth consumers. Keep this page open as you continue
2016-09-29 09:46:39 +05:30
the configuration.
![Bitbucket OAuth key](img/bitbucket_oauth_keys.png)
1. On your GitLab server, open the configuration file:
2015-04-26 12:48:37 +05:30
```
2016-09-29 09:46:39 +05:30
# For Omnibus packages
sudo editor /etc/gitlab/gitlab.rb
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
# For installations from source
sudo -u git -H editor /home/git/gitlab/config/gitlab.yml
```
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
1. Add the Bitbucket provider configuration:
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
For Omnibus packages:
2015-04-26 12:48:37 +05:30
```ruby
2018-11-08 19:23:39 +05:30
gitlab_rails['omniauth_enabled'] = true
2016-09-29 09:46:39 +05:30
gitlab_rails['omniauth_providers'] = [
{
"name" => "bitbucket",
"app_id" => "BITBUCKET_APP_KEY",
"app_secret" => "BITBUCKET_APP_SECRET",
"url" => "https://bitbucket.org/"
}
]
2015-04-26 12:48:37 +05:30
```
2016-09-29 09:46:39 +05:30
For installations from source:
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
```yaml
2018-11-08 19:23:39 +05:30
omniauth:
enabled: true
providers:
- { name: 'bitbucket',
app_id: 'BITBUCKET_APP_KEY',
app_secret: 'BITBUCKET_APP_SECRET',
url: 'https://bitbucket.org/' }
2015-04-26 12:48:37 +05:30
```
2016-09-29 09:46:39 +05:30
---
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
Where `BITBUCKET_APP_KEY` is the Key and `BITBUCKET_APP_SECRET` the Secret
from the Bitbucket application page.
2015-04-26 12:48:37 +05:30
1. Save the configuration file.
2018-11-18 11:00:15 +05:30
1. For the changes to take effect, [reconfigure GitLab][] if you installed via
Omnibus, or [restart][] if installed from source.
2015-04-26 12:48:37 +05:30
2016-09-29 09:46:39 +05:30
On the sign in page there should now be a Bitbucket icon below the regular sign
in form. Click the icon to begin the authentication process. Bitbucket will ask
the user to sign in and authorize the GitLab application. If everything goes
well, the user will be returned to GitLab and will be signed in.
2015-04-26 12:48:37 +05:30
## Bitbucket project import
2017-08-17 22:00:37 +05:30
Once the above configuration is set up, you can use Bitbucket to sign into
GitLab and [start importing your projects][bb-import].
2015-04-26 12:48:37 +05:30
2018-11-18 11:00:15 +05:30
If you want to import projects from Bitbucket, but don't want to enable signing in,
you can [disable Sign-Ins in the admin panel](omniauth.md#enable-or-disable-sign-in-with-an-omniauth-provider-without-disabling-import-sources).
2018-11-08 19:23:39 +05:30
2016-09-29 09:46:39 +05:30
[init-oauth]: omniauth.md#initial-omniauth-configuration
2017-08-17 22:00:37 +05:30
[bb-import]: ../workflow/importing/import_projects_from_bitbucket.md
[bb-old]: https://gitlab.com/gitlab-org/gitlab-ce/blob/8-14-stable/doc/integration/bitbucket.md
2016-09-29 09:46:39 +05:30
[bitbucket-docs]: https://confluence.atlassian.com/bitbucket/use-the-ssh-protocol-with-bitbucket-cloud-221449711.html#UsetheSSHprotocolwithBitbucketCloud-KnownhostorBitbucket%27spublickeyfingerprints
2018-11-18 11:00:15 +05:30
[reconfigure GitLab]: ../administration/restart_gitlab.md#omnibus-gitlab-reconfigure
[restart]: ../administration/restart_gitlab.md#installations-from-source