gitlab-org--gitlab-foss/doc/administration/raketasks/github_import.md

38 lines
1.3 KiB
Markdown
Raw Normal View History

2017-04-06 08:47:40 -04:00
# GitHub import
>**Note:**
>
> - [Introduced][ce-10308] in GitLab 9.1.
2017-06-13 08:10:31 -04:00
> - You need a personal access token in order to retrieve and import GitHub
2017-04-06 08:47:40 -04:00
> projects. You can get it from: https://github.com/settings/tokens
> - You also need to pass an username as the second argument to the rake task
> which will become the owner of the project.
2017-10-17 02:06:04 -04:00
> - You can also resume an import with the same command.
2017-04-06 08:47:40 -04:00
To import a project from the list of your GitHub projects available:
```bash
# Omnibus installations
sudo gitlab-rake import:github[access_token,root,foo/bar]
# Installations from source
bundle exec rake import:github[access_token,root,foo/bar] RAILS_ENV=production
```
In this case, `access_token` is your GitHub personal access token, `root`
2017-06-13 08:10:31 -04:00
is your GitLab username, and `foo/bar` is the new GitLab namespace/project that
2017-04-06 08:47:40 -04:00
will get created from your GitHub project. Subgroups are also possible: `foo/foo/bar`.
To import a specific GitHub project (named `foo/github_repo` here):
```bash
# Omnibus installations
sudo gitlab-rake import:github[access_token,root,foo/bar,foo/github_repo]
# Installations from source
bundle exec rake import:github[access_token,root,foo/bar,foo/github_repo] RAILS_ENV=production
```
[ce-10308]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/10308