@@ -129,7 +129,7 @@ request that potentially fixes it.
...
@@ -129,7 +129,7 @@ request that potentially fixes it.
### Feature proposals
### Feature proposals
To create a feature proposal for CE and CI, open an issue on the
To create a feature proposal for CE, open an issue on the
[issue tracker of CE][ce-tracker].
[issue tracker of CE][ce-tracker].
For feature proposals for EE, open an issue on the
For feature proposals for EE, open an issue on the
...
@@ -144,16 +144,7 @@ code snippet right after your description in a new line: `~"feature proposal"`.
...
@@ -144,16 +144,7 @@ code snippet right after your description in a new line: `~"feature proposal"`.
Please keep feature proposals as small and simple as possible, complex ones
Please keep feature proposals as small and simple as possible, complex ones
might be edited to make them small and simple.
might be edited to make them small and simple.
You are encouraged to use the template below for feature proposals.
Please submit Feature Proposals using the ['Feature Proposal' issue template](.gitlab/issue_templates/Feature Proposal.md) provided on the issue tracker.
```
## Description
Include problem, use cases, benefits, and/or goals
## Proposal
## Links / references
```
For changes in the interface, it can be helpful to create a mockup first.
For changes in the interface, it can be helpful to create a mockup first.
If you want to create something yourself, consider opening an issue first to
If you want to create something yourself, consider opening an issue first to
...
@@ -166,55 +157,11 @@ submitting your own, there's a good chance somebody else had the same issue or
...
@@ -166,55 +157,11 @@ submitting your own, there's a good chance somebody else had the same issue or
feature proposal. Show your support with an award emoji and/or join the
feature proposal. Show your support with an award emoji and/or join the
discussion.
discussion.
Please submit bugs using the following template in the issue description area.
Please submit bugs using the ['Bug' issue template](.gitlab/issue_templates/Bug.md) provided on the issue tracker.
The text in the parenthesis is there to help you with what to include. Omit it
The text in the parenthesis is there to help you with what to include. Omit it
when submitting the actual issue. You can copy-paste it and then edit as you
when submitting the actual issue. You can copy-paste it and then edit as you
see fit.
see fit.
```
## Summary
(Summarize your issue in one sentence - what goes wrong, what did you expect to happen)
## Steps to reproduce
(How one can reproduce the issue - this is very important)
## Expected behavior
(What you should see instead)
## Relevant logs and/or screenshots
(Paste any relevant logs - please use code blocks (```) to format console output,
logs, and code as it's very hard to read otherwise.)
## Output of checks
### Results of GitLab Application Check
(For installations with omnibus-gitlab package run and paste the output of:
sudo gitlab-rake gitlab:check SANITIZE=true)
(For installations from source run and paste the output of:
=link_tonamespace_project_tag_path(@project.namespace,@project,@tag.name),class: 'btn btn-remove remove-row grouped has-tooltip',title: "Delete tag",method: :delete,data: {confirm: "Deleting the '#{@tag.name}' tag cannot be undone. Are you sure?"}do
=link_tonamespace_project_tag_path(@project.namespace,@project,@tag.name),class: 'btn btn-remove remove-row grouped has-tooltip',title: "Delete tag",method: :delete,data: {confirm: "Deleting the '#{@tag.name}' tag cannot be undone. Are you sure?"}do
=link_to'Delete',polymorphic_path([@project.namespace.becomes(Namespace),@project,issuable]),data: {confirm: "#{issuable.class.name.titleize} will be removed! Are you sure?"},
=link_to'Delete',polymorphic_path([@project.namespace.becomes(Namespace),@project,issuable]),data: {confirm: "#{issuable.class.name.titleize} will be removed! Are you sure?"},
Import projects from Bitbucket and login to your GitLab instance with your Bitbucket account.
Import projects from Bitbucket.org and login to your GitLab instance with your
Bitbucket.org account.
To enable the Bitbucket OmniAuth provider you must register your application with Bitbucket.
## Overview
Bitbucket will generate an application ID and secret key for you to use.
1. Sign in to Bitbucket.
You can set up Bitbucket.org as an OAuth provider so that you can use your
credentials to authenticate into GitLab or import your projects from
Bitbucket.org.
1. Navigate to your individual user settings or a team's settings, 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.
- 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
1. Follow the [Initial OmniAuth Configuration](omniauth.md#initial-omniauth-configuration)
for initial settings.
1. Add the Bitbucket provider configuration:
For omnibus package:
For Omnibus packages:
```ruby
```ruby
gitlab_rails['omniauth_providers'] = [
gitlab_rails['omniauth_providers'] = [
{
{
"name" => "bitbucket",
"name" => "bitbucket",
"app_id" => "YOUR_KEY",
"app_id" => "BITBUCKET_APP_KEY",
"app_secret" => "YOUR_APP_SECRET",
"app_secret" => "BITBUCKET_APP_SECRET",
"url" => "https://bitbucket.org/"
"url" => "https://bitbucket.org/"
}
}
]
]
```
```
For installation from source:
For installations from source:
```
```yaml
- { name: 'bitbucket', app_id: 'YOUR_KEY',
- { name: 'bitbucket',
app_secret: 'YOUR_APP_SECRET' }
app_id: 'BITBUCKET_APP_KEY',
app_secret: 'BITBUCKET_APP_SECRET' }
```
```
1. Change 'YOUR_APP_ID' to the key from the Bitbucket application page from step 7.
---
1. Change 'YOUR_APP_SECRET' to the secret from the Bitbucket application page from step 7.
Where `BITBUCKET_APP_KEY` is the Key and `BITBUCKET_APP_SECRET` the Secret
from the Bitbucket application page.
1. Save the configuration file.
1. Save the configuration file.
1.[Reconfigure][] or [restart GitLab][] for the changes to take effect if you
installed GitLab via Omnibus or from source respectively.
1. If you're using the omnibus package, reconfigure GitLab (```gitlab-ctl reconfigure```).
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
1. Restart GitLab for the changes to take effect.
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.
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.
## Bitbucket project import
## Bitbucket project import
To allow projects to be imported directly into GitLab, Bitbucket requires two extra setup steps compared to GitHub and GitLab.com.
To allow projects to be imported directly into GitLab, Bitbucket requires two
extra setup steps compared to [GitHub](github.md) and [GitLab.com](gitlab.md).
Bitbucket doesn't allow OAuth applications to clone repositories over HTTPS, and instead requires GitLab to use SSH and identify itself using your GitLab server's SSH key.
Bitbucket doesn't allow OAuth applications to clone repositories over HTTPS, and
instead requires GitLab to use SSH and identify itself using your GitLab
server's SSH key.
### Step 1: Public key
To be able to access repositories on Bitbucket, GitLab will automatically
register your public key with Bitbucket as a deploy key for the repositories to
be imported. Your public key needs to be at `~/.ssh/bitbucket_rsa` which
translates to `/var/opt/gitlab/.ssh/bitbucket_rsa` for Omnibus packages and to
`/home/git/.ssh/bitbucket_rsa.pub` for installations from source.
To be able to access repositories on Bitbucket, GitLab will automatically register your public key with Bitbucket as a deploy key for the repositories to be imported. Your public key needs to be at `~/.ssh/bitbucket_rsa.pub`, which will expand to `/home/git/.ssh/bitbucket_rsa.pub` in most configurations.
---
If you have that file in place, you're all set and should see the "Import projects from Bitbucket" option enabled. If you don't, do the following:
Below are the steps that will allow GitLab to be able to import your projects
from Bitbucket.
1. Create a new SSH key:
1. Make sure you [have enabled the Bitbucket OAuth support](#bitbucket-omniauth-provider).
1. Create a new SSH key with an **empty passphrase**:
```sh
```sh
sudo -u git -H ssh-keygen
sudo -u git -H ssh-keygen
```
```
When asked `Enter file in which to save the key` specify the correct path, eg. `/home/git/.ssh/bitbucket_rsa`.
When asked to 'Enter file in which to save the key' enter:
Make sure to use an **empty passphrase**.
`/var/opt/gitlab/.ssh/bitbucket_rsa` for Omnibus packages or
`/home/git/.ssh/bitbucket_rsa` for installations from source. The name is
important so make sure to get it right.
1. Configure SSH client to use your new key:
> **Warning:**
This key must NOT be associated with ANY existing Bitbucket accounts. If it
is, the import will fail with an `Access denied! Please verify you can add
deploy keys to this repository.` error.
Open the SSH configuration file of the git user.
1. Next, you need to to configure the SSH client to use your new key. Open the
SSH configuration file of the `git` user:
```sh
```
# For Omnibus packages
sudo editor /var/opt/gitlab/.ssh/config
# For installations from source
sudo editor /home/git/.ssh/config
sudo editor /home/git/.ssh/config
```
```
Add a host configuration for `bitbucket.org`.
1. Add a host configuration for `bitbucket.org`:
```sh
```sh
Host bitbucket.org
Host bitbucket.org
...
@@ -113,28 +166,46 @@ If you have that file in place, you're all set and should see the "Import projec
...
@@ -113,28 +166,46 @@ If you have that file in place, you're all set and should see the "Import projec
User git
User git
```
```
### Step 2: Known hosts
1. Save the file and exit.
1. Manually connect to `bitbucket.org` over SSH, while logged in as the `git`
To allow GitLab to connect to Bitbucket over SSH, you need to add 'bitbucket.org' to your GitLab server's known SSH hosts. Take the following steps to do so:
user that GitLab will use:
1. Manually connect to 'bitbucket.org' over SSH, while logged in as the `git` account that GitLab will use:
```sh
```sh
sudo -u git -H ssh bitbucket.org
sudo -u git -H ssh bitbucket.org
```
```
1. Verify the RSA key fingerprint you'll see in the response matches the one in the [Bitbucket documentation](https://confluence.atlassian.com/display/BITBUCKET/Use+the+SSH+protocol+with+Bitbucket#UsetheSSHprotocolwithBitbucket-KnownhostorBitbucket'spublickeyfingerprints)(the specific IP address doesn't matter):
That step is performed because GitLab needs to connect to Bitbucket over SSH,
in order to add `bitbucket.org` to your GitLab server's known SSH hosts.
1. Verify the RSA key fingerprint you'll see in the response matches the one
in the [Bitbucket documentation][bitbucket-docs] (the specific IP address
doesn't matter):
```sh
```sh
The authenticity of host 'bitbucket.org (207.223.240.182)' can't be established.
The authenticity of host 'bitbucket.org (104.192.143.1)' can't be established.
RSA key fingerprint is 97:8c:1b:f2:6f:14:6b:5c:3b:ec:aa:46:46:74:7c:40.
RSA key fingerprint is SHA256:zzXQOXSRBEiUtuE8AikJYKwbHaxvSc0ojez9YXaGp1A.
Are you sure you want to continue connecting (yes/no)?
Are you sure you want to continue connecting (yes/no)?
```
```
1. If the fingerprint matches, type `yes` to continue connecting and have 'bitbucket.org' be added to your known hosts.
1. If the fingerprint matches, type `yes` to continue connecting and have
`bitbucket.org` be added to your known SSH hosts. After confirming you should
see a permission denied message. If you see an authentication successful
message you have done something wrong. The key you are using has already been
added to a Bitbucket account and will cause the import script to fail. Ensure
the key you are using CANNOT authenticate with Bitbucket.
1. Restart GitLab to allow it to find the new public key.
Your GitLab server is now able to connect to Bitbucket over SSH. You should be
able to see the "Import projects from Bitbucket" option on the New Project page
enabled.
1. Your GitLab server is now able to connect to Bitbucket over SSH.
## Acknowledgemts
1. Restart GitLab to allow it to find the new public key.
Special thanks to the writer behind the following article:
