From 08da9387f82d75f6c987d5b8583b1e8e18140829 Mon Sep 17 00:00:00 2001 From: Brian Hogan Date: Thu, 3 Oct 2019 11:57:53 -0500 Subject: [PATCH] Fleshed out explanations in rsync deployment Added some additional explanations and split up a couple command blocks to make things more clear to people less experienced with this kind of deployment. --- .../deployment-with-rsync.md | 42 ++++++++++++++----- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/content/en/hosting-and-deployment/deployment-with-rsync.md b/content/en/hosting-and-deployment/deployment-with-rsync.md index 8d0137ad7..e722a51ec 100644 --- a/content/en/hosting-and-deployment/deployment-with-rsync.md +++ b/content/en/hosting-and-deployment/deployment-with-rsync.md @@ -4,7 +4,7 @@ linktitle: Deployment with Rsync description: If you have access to your web host with SSH, you can use a simple rsync one-liner to incrementally deploy your entire Hugo website. date: 2017-02-01 publishdate: 2017-02-01 -lastmod: 2017-02-01 +lastmod: 2019-10-03 categories: [hosting and deployment] keywords: [rsync,deployment] authors: [Adrien Poupin] @@ -22,6 +22,7 @@ notesforauthors: ## Assumptions +* A web host running a web server. This could be a shared hosting environment or a VPS. * Access to your web host with SSH * A functional static website built with Hugo @@ -31,11 +32,11 @@ The spoiler is that you can deploy your entire website with a command that looks hugo && rsync -avz --delete public/ www-data@ftp.topologix.fr:~/www/ ``` -As you will see, we put it in a shell script file, which makes building and deployment as easy as executing `./deploy`. +As you will see, we'll put this command in a shell script file, which makes building and deployment as easy as executing `./deploy`. -## Install SSH Key +## Copy Your SSH Key to your Host -If it is not done yet, we will make an automated way to SSH to your server. If you have already installed an SSH key, switch to the next section. +To make logging in to your server more secure and less interactive, you can upload your SSH key. If you have already installed your SSH key to your server, you can move on to the next section. First, install the ssh client. On Debian/Ubuntu/derivates, use the following command: @@ -43,11 +44,23 @@ First, install the ssh client. On Debian/Ubuntu/derivates, use the following com sudo apt-get install openssh-client {{< /code >}} -Then generate your ssh key by entering the following commands: +Then generate your ssh key. First, create the `.ssh` directory in your home directory if it doesn't exist: ``` ~$ cd && mkdir .ssh & cd .ssh +``` + +Next, execute this command to generate a new keypair called `rsa_id`: + +``` ~/.ssh/$ ssh-keygen -t rsa -q -C "For SSH" -f rsa_id +``` + +You'll be prompted for a passphrase, which is an extra layer of protection. Enter the passphrase you'd like to use, and then enter it again when prompted, or leave it blank if you don't want to have a passphrase. Not using a passphrase will let you transfer files non-interactively, as you won't be prompted for a password when you log in, but it is slightly less secure. + +To make logging in easier, add a definition for your web host to the file `~/.ssh/config` with the following command, replacing `HOST` with the IP address or hostname of your web host, and `USER` with the username you use to log in to your web host when transfering files: + +``` ~/.ssh/$ cat >> config <