From 58662f9a25f4cf5b674bbf980310eea5067ebc53 Mon Sep 17 00:00:00 2001 From: Jakub Al-Khalili Date: Wed, 28 Aug 2019 13:26:39 +0200 Subject: [PATCH 1/3] #79 Improve docs - add ssh key generation info --- documentation/v0.2.0/getting-started.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/documentation/v0.2.0/getting-started.md b/documentation/v0.2.0/getting-started.md index 715e2474..f5e2cc20 100644 --- a/documentation/v0.2.0/getting-started.md +++ b/documentation/v0.2.0/getting-started.md @@ -229,6 +229,25 @@ If your GitHub repository is **private** you have to configure SSH or username/p ### SSH authentication +#### Generate SSH Keys + +There are two methods of SSH private key generation: + +```bash +$ openssl genrsa -out 2048 +``` + +or + +```bash +$ ssh-keygen -t rsa -b 2048 +$ ssh-keygen -p -f -m pem +``` + +Then copy content from generated file. + +#### Configure SSH authentication + Configure seed job like: ``` From 76fe140baaa23ef2b05a45e060cc6e115b1721d7 Mon Sep 17 00:00:00 2001 From: Jakub Al-Khalili Date: Wed, 28 Aug 2019 14:10:06 +0200 Subject: [PATCH 2/3] Improve documentation - add notice about public key --- documentation/v0.2.0/getting-started.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/documentation/v0.2.0/getting-started.md b/documentation/v0.2.0/getting-started.md index f5e2cc20..37d4adfd 100644 --- a/documentation/v0.2.0/getting-started.md +++ b/documentation/v0.2.0/getting-started.md @@ -244,7 +244,19 @@ $ ssh-keygen -t rsa -b 2048 $ ssh-keygen -p -f -m pem ``` -Then copy content from generated file. +Then copy content from generated file. + +#### Public key + +If you want to upload your public key to your Git server you need to extract it. + +If key was generated by `openssl` then you need to type this to extract public key: + +```bash +$ openssl rsa -in -pubout > .pub +``` + +If key was generated by `ssh-keygen` the public key content is located in .pub and there is no need to extract public key #### Configure SSH authentication From c25d0ce3e84e88c5b53880371e8a1511b6787ac3 Mon Sep 17 00:00:00 2001 From: Jakub Al-Khalili Date: Wed, 28 Aug 2019 14:55:10 +0200 Subject: [PATCH 3/3] Improve v0.1.1 documentation - add notice about public key --- documentation/v0.1.1/getting-started.md | 31 +++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/documentation/v0.1.1/getting-started.md b/documentation/v0.1.1/getting-started.md index 2e7775c5..12b1cc48 100644 --- a/documentation/v0.1.1/getting-started.md +++ b/documentation/v0.1.1/getting-started.md @@ -227,6 +227,37 @@ If your GitHub repository is **private** you have to configure SSH or username/p ### SSH authentication +#### Generate SSH Keys + +There are two methods of SSH private key generation: + +```bash +$ openssl genrsa -out 2048 +``` + +or + +```bash +$ ssh-keygen -t rsa -b 2048 +$ ssh-keygen -p -f -m pem +``` + +Then copy content from generated file. + +#### Public key + +If you want to upload your public key to your Git server you need to extract it. + +If key was generated by `openssl` then you need to type this to extract public key: + +```bash +$ openssl rsa -in -pubout > .pub +``` + +If key was generated by `ssh-keygen` the public key content is located in .pub and there is no need to extract public key + +#### Configure SSH authentication + Configure seed job like: ```