Commit 717e137d authored by Brad King's avatar Brad King
Browse files

Documentation: Optionally configure Git to use ssh instead of https

Some users may prefer to use "git@gitlab.kitware.com:" instead of
"https://gitlab.kitware.com".  Add instructions explaining how to
do this so that it affects all repositories without manually
configuring each one.
parent da57333a
......@@ -22,7 +22,9 @@ Before you begin, perform initial setup:
2. [Fork ParaView][] into your user's namespace on GitLab.
3. Follow the [download instructions](download.md#clone) to create a
local clone of the main ParaView repository:
local clone of the main ParaView repository. Optionally configure
Git to [use SSH instead of HTTPS](download.md#use-ssh-instead-of-https).
Then clone:
$ git clone https://gitlab.kitware.com/paraview/paraview.git ParaView
$ cd ParaView
......
......@@ -9,6 +9,8 @@ See the [README](README.md) for more information.
Clone
-----
Optionally configure Git to [use SSH instead of HTTPS](#use-ssh-instead-of-https).
Clone ParaView using the commands:
$ git clone --recursive https://gitlab.kitware.com/paraview/paraview.git ParaView
......@@ -49,3 +51,30 @@ different release. One may list available tags:
$ git tag
and then checkout any tag listed.
Use SSH instead of HTTPS
------------------------
Git can be configured to access ``gitlab.kitware.com`` repositories through
the ``ssh`` protocol instead of ``https`` without having to manually change
every URL found in instructions, scripts, and submodule configurations.
1. Register [GitLab Access][] to create an account and select a user name.
2. Add [SSH Keys][] to your GitLab account to authenticate your user via
the ``ssh`` protocol.
3. Configure Git to use ``ssh`` instead of ``https`` for all repositories
on ``gitlab.kitware.com``:
$ git config --global url."git@gitlab.kitware.com:".insteadOf https://gitlab.kitware.com/
The ``--global`` option causes this configuration to be stored in
``~/.gitconfig`` instead of in any repository, so it will map URLs
for all repositories.
4. Return to the [Clone](#clone) step above and use the instructions as
written. There is no need to manually specify the ssh protocol when
cloning. The Git ``insteadOf`` configuration will map it for you.
[GitLab Access]: https://gitlab.kitware.com/users/sign_in
[SSH Keys]: https://gitlab.kitware.com/profile/keys
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment