Add an explanation of options for GitLab

This commit is contained in:
Takeru Naito 2016-11-21 20:10:21 +09:00
parent 7ac4f71f42
commit 8ce4938097
No known key found for this signature in database
GPG key ID: 0967B4FC0A2D3E0E

View file

@ -98,11 +98,19 @@ git-open can automatically guess the corresponding repository page for remotes
#### GitLab support
To configure GitLab support you need to set `gitopen.gitlab.domain`:
To configure GitLab support you need to set some options.
| option name | description | example |
| ------------------------- | ---------------------------------------------------------- | ------------------ |
| gitopen.gitlab.domain | The (web)domain name that will work for most of the people | gitlab.example.com |
| gitopen.gitlab.ssh.domain | A specific ssh domain name, *if needed* | git.example.com |
| gitopen.gitlab.ssh.port | A specific ssh port, *if needed* | 10022 |
```sh
# use --global to set across all repos, instead of just the local one
git config [--global] gitopen.gitlab.domain [yourdomain.here]
git config [--global] gitopen.gitlab.domain [value]
git config [--global] gitopen.gitlab.ssh.domain [value]
git config [--global] gitopen.gitlab.ssh.port [value]
```
## Related projects / alternatives