diff options
author | Ciro Santilli <ciro.santilli@gmail.com> | 2014-04-25 00:48:22 +0200 |
---|---|---|
committer | Ciro Santilli <ciro.santilli@gmail.com> | 2014-06-03 23:16:31 +0200 |
commit | fd348de76d651d49acc8eb742cc647dc777ef5fc (patch) | |
tree | 26f42bef57c9a636eff0a548a29cb1e2e6d12c8c /doc/ssh | |
parent | de1a7aa7eb523cf2fdad12f8eeda2ba4c5b51820 (diff) | |
download | gitlab-ce-fd348de76d651d49acc8eb742cc647dc777ef5fc.tar.gz |
Update docs to markdown style guide.
Diffstat (limited to 'doc/ssh')
-rw-r--r-- | doc/ssh/README.md | 6 | ||||
-rw-r--r-- | doc/ssh/deploy_keys.md | 11 | ||||
-rw-r--r-- | doc/ssh/ssh.md | 11 |
3 files changed, 10 insertions, 18 deletions
diff --git a/doc/ssh/README.md b/doc/ssh/README.md index 76d9e8bb075..c87fffd7d2c 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -1,2 +1,4 @@ -+ [Deploy keys](deploy_keys.md) -+ [SSH](ssh.md) +# SSH + +- [Deploy keys](deploy_keys.md) +- [SSH](ssh.md) diff --git a/doc/ssh/deploy_keys.md b/doc/ssh/deploy_keys.md index e113160c9bc..dcca8bdc61a 100644 --- a/doc/ssh/deploy_keys.md +++ b/doc/ssh/deploy_keys.md @@ -2,13 +2,8 @@ Deploy keys allow read-only access one or multiple projects with a single SSH key. -This is really useful for cloning repositories to your Continuous Integration (CI) server. -By using a deploy keys you don't have to setup a dummy user account. +This is really useful for cloning repositories to your Continuous Integration (CI) server. By using a deploy keys you don't have to setup a dummy user account. -If you are a project master or owner you can add a deploy key in the project settings under the section Deploy Keys. -Press the 'New Deploy Key' button and upload a public ssh key. -After this the machine that uses the corresponding private key has read-only access to the project. +If you are a project master or owner you can add a deploy key in the project settings under the section Deploy Keys. Press the 'New Deploy Key' button and upload a public ssh key. After this the machine that uses the corresponding private key has read-only access to the project. -You can't add the same deploy key twice with the 'New Deploy Key' option. -If you want to add the same key to another project please enable it in the list that says 'Deploy keys from projects available to you'. -All the deploy keys of all the projects you have access to are available. This project access can happen through being a direct member of the project or through a group. See `def accessible_deploy_keys` in `app/models/user.rb` for more information. +You can't add the same deploy key twice with the 'New Deploy Key' option. If you want to add the same key to another project please enable it in the list that says 'Deploy keys from projects available to you'. All the deploy keys of all the projects you have access to are available. This project access can happen through being a direct member of the project or through a group. See `def accessible_deploy_keys` in `app/models/user.rb` for more information. diff --git a/doc/ssh/ssh.md b/doc/ssh/ssh.md index f89b6a14ce1..d466c1bde72 100644 --- a/doc/ssh/ssh.md +++ b/doc/ssh/ssh.md @@ -2,13 +2,9 @@ SSH key allows you to establish a secure connection between your computer and GitLab +Before generating an SSH key, check if your system already has one by running `cat ~/.ssh/id_rsa.pub` If your see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step. -Before generating an SSH key, check if your system already has one by running `cat ~/.ssh/id_rsa.pub` -If your see a long string starting with `ssh-rsa` or `ssh-dsa`, you can skip the ssh-keygen step. - - -To generate a new SSH key just open your terminal and use code below. The ssh-keygen command prompts you for a location and filename to store the key pair and for a password. -When prompted for the location and filename you can press enter to use the default. +To generate a new SSH key just open your terminal and use code below. The ssh-keygen command prompts you for a location and filename to store the key pair and for a password. When prompted for the location and filename you can press enter to use the default. It is a best practice to use a password for an SSH key but it is not required and you can skip creating a password by pressing enter. Note that the password you choose here can't be altered or retrieved. @@ -22,5 +18,4 @@ Use the code below to show your public key. cat ~/.ssh/id_rsa.pub ``` -Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your user profile. -Please copy the complete key starting with `ssh-` and ending with your username and host. +Copy-paste the key to the 'My SSH Keys' section under the 'SSH' tab in your user profile. Please copy the complete key starting with `ssh-` and ending with your username and host. |