diff options
author | Marcia Ramos <virtua.creative@gmail.com> | 2018-03-02 12:12:03 -0300 |
---|---|---|
committer | Marcia Ramos <virtua.creative@gmail.com> | 2018-03-02 12:12:03 -0300 |
commit | 1babee405bf0ee75d69816a74b79a472127536d0 (patch) | |
tree | 0ff398183576ab16842f7a986dc0b48a02e5b9fc | |
parent | a8f94c5f81504f6498a445ae0126d136ad7860bd (diff) | |
download | gitlab-ce-docs-darwinjs-update-ssh.tar.gz |
copyeditdocs-darwinjs-update-ssh
-rw-r--r-- | doc/ssh/README.md | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/doc/ssh/README.md b/doc/ssh/README.md index 51e5668e273..aa14a39e4c9 100644 --- a/doc/ssh/README.md +++ b/doc/ssh/README.md @@ -35,8 +35,8 @@ to clipboard step. If you don't see the string or would like to generate a SSH key pair with a custom name continue onto the next step. -> -NOTE: **Note:** Public SSH key may also be named as follows: +Note that Public SSH key may also be named as follows: + - `id_dsa.pub` - `id_ecdsa.pub` - `id_ed25519.pub` @@ -73,7 +73,7 @@ NOTE: **Note:** Public SSH key may also be named as follows: key pair, but it is not required and you can skip creating a password by pressing enter. - >NOTE: **Note:** + NOTE: **Note:** If you want to change the password of your SSH key pair, you can use `ssh-keygen -p <keyname>`. @@ -168,7 +168,7 @@ Deploy keys allow read-only or read-write (if enabled) access to one or multiple projects with a single SSH key pair. This is really useful for cloning repositories to your Continuous -Integration (CI) server. By using deploy keys, you don't have to setup a +Integration (CI) server. By using deploy keys, you don't have to set up a dummy user account. If you are a project master or owner, you can add a deploy key in the @@ -203,8 +203,8 @@ Global Shared Keys can provide greater security compared to Per-Project Deploy Keys since an administrator of the target integrated system is the only one who needs to know and configure the private key. -GitLab administrators setup Global Deploy keys in the Admin area under the -section **Deploy Keys**. Ensure keys have a meaningful title as that will be +GitLab administrators set up Global Deploy keys in the Admin area under the +section **Deploy Keys**. Ensure keys have a meaningful title as that will be the primary way for project masters and owners to identify the correct Global Deploy key to add. For instance, if the key gives access to a SaaS CI instance, use the name of that service in the key name if that is all it is used for. @@ -218,10 +218,12 @@ and owners can add it in project's **Settings > Repository** section by expandin **Deploy Key** section and clicking **Enable** next to the appropriate key listed under **Public deploy keys available to any project**. -NOTE: **Note:** The heading 'Public deploy keys available to any project' only appears +NOTE: **Note:** +The heading **Public deploy keys available to any project** only appears if there is at least one Global Deploy Key configured. -NOTE: **Note:** Defining Global Deploy Keys does not expose any given repository via +CAUTION: **Warning:** +Defining Global Deploy Keys does not expose any given repository via the key until that respository adds the Global Deploy Key to their project. In this way the Global Deploy Keys enable access by other systems, but do not implicitly give any access just by setting them up. |