From ffff33f8fe0318345a4f00f0e847325954b2a3ed Mon Sep 17 00:00:00 2001 From: Bo-Yi Wu Date: Thu, 13 Aug 2020 01:06:27 +0800 Subject: [PATCH] docs: update readme --- README.md | 36 ++++++++++++++++++++++-------------- 1 file changed, 22 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 747a601..6ffa1c8 100644 --- a/README.md +++ b/README.md @@ -80,20 +80,28 @@ SSH Proxy Setting: * proxy_cipher - the allowed cipher algorithms. If unspecified then a sensible ### Setting up SSH Key -Make sure to follow the below steps while creating SSH Keys and using them. -* Login with username specified in Github Secrets. -* Generate a RSA Key-Pair. - ```bash - ssh-keygen -t rsa -b 4096 -C "your_email@example.com" - ``` -* Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/). - ```bash - cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys - ``` -* Copy Private Key content and paste in Github Secrets. - ```bash - clip < ~/.ssh/id_rsa - ``` + +Make sure to follow the below steps while creating SSH Keys and using them. +Login with username specified in Github Secrets. Generate a RSA Key-Pair: + + ```bash + ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + ``` + +Add newly generated key into Authorized keys. Read more about authorized keys [here](https://www.ssh.com/ssh/authorized_keys/). + +```bash +cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys +``` + +Copy Private Key content and paste in Github Secrets. + +```bash +clip < ~/.ssh/id_rsa +``` + +See the detail information about [SSH login without password](http://www.linuxproblem.org/art_9.html) + ### Example Executing remote ssh commands using password.