deployment-with-rsync.md (4326B)
1 ---
2 title: Deployment with Rsync
3 linktitle: Deployment with Rsync
4 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.
5 date: 2017-02-01
6 publishdate: 2017-02-01
7 categories: [hosting and deployment]
8 keywords: [rsync,deployment]
9 authors: [Adrien Poupin]
10 menu:
11 docs:
12 parent: "hosting-and-deployment"
13 weight: 70
14 weight: 70
15 sections_weight: 70
16 draft: false
17 aliases: [/tutorials/deployment-with-rsync/]
18 toc: true
19 notesforauthors:
20 ---
21
22 ## Assumptions
23
24 * A web host running a web server. This could be a shared hosting environment or a VPS.
25 * Access to your web host with SSH
26 * A functional static website built with Hugo
27
28 The spoiler is that you can deploy your entire website with a command that looks like the following:
29
30 ```
31 hugo && rsync -avz --delete public/ www-data@ftp.topologix.fr:~/www/
32 ```
33
34 As you will see, we'll put this command in a shell script file, which makes building and deployment as easy as executing `./deploy`.
35
36 ## Copy Your SSH Key to your Host
37
38 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.
39
40 First, install the ssh client. On Debian/Ubuntu/derivates, use the following command:
41
42 {{< code file="install-openssh.sh" >}}
43 sudo apt-get install openssh-client
44 {{< /code >}}
45
46 Then generate your ssh key. First, create the `.ssh` directory in your home directory if it doesn't exist:
47
48 ```
49 ~$ cd && mkdir .ssh & cd .ssh
50 ```
51
52 Next, execute this command to generate a new keypair called `rsa_id`:
53
54 ```
55 ~/.ssh/$ ssh-keygen -t rsa -q -C "For SSH" -f rsa_id
56 ```
57
58 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.
59
60 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 transferring files:
61
62 ```
63 ~/.ssh/$ cat >> config <<EOF
64 Host HOST
65 Hostname HOST
66 Port 22
67 User USER
68 IdentityFile ~/.ssh/rsa_id
69 EOF
70 ```
71
72 Then copy your ssh public key to the remote server with the `ssh-copy-id` command:
73
74 ```
75 ~/.ssh/$ ssh-copy-id -i rsa_id.pub USER@HOST.com
76 ```
77
78 Now you can easily connect to the remote server:
79
80 ```
81 ~$ ssh user@host
82 Enter passphrase for key '/home/mylogin/.ssh/rsa_id':
83 ```
84
85 Now that you can log in with your SSH key, let's create a script to automate deployment of your Hugo site.
86
87 ## Shell Script
88
89 Create a new script called `deploy` the root of your Hugo tree:
90
91 ```
92 ~/websites/topologix.fr$ editor deploy
93 ```
94
95 Add the following content. Replace the `USER`, `HOST`, and `DIR` values with your own values:
96
97 ```
98 #!/bin/sh
99 USER=my-user
100 HOST=my-server.com
101 DIR=my/directory/to/topologix.fr/ # the directory where your web site files should go
102
103 hugo && rsync -avz --delete public/ ${USER}@${HOST}:~/${DIR}
104
105 exit 0
106 ```
107
108 Note that `DIR` is the relative path from the remote user's home. If you have to specify a full path (for instance `/var/www/mysite/`) you must change `~/${DIR}` to `${DIR}` inside the command line. For most cases you should not have to.
109
110 Save and close, and make the `deploy` file executable:
111
112 ```
113 ~/websites/topologix.fr$ chmod +x deploy
114 ```
115
116 Now you only have to enter the following command to deploy and update your website:
117
118 ```
119 ~/websites/topologix.fr$ ./deploy
120 ```
121
122 Your site builds and deploys:
123
124 ```
125 Started building sites ...
126 Built site for language en:
127 0 draft content
128 0 future content
129 0 expired content
130 5 pages created
131 0 non-page files copied
132 0 paginator pages created
133 0 tags created
134 0 categories created
135 total in 56 ms
136 sending incremental file list
137 404.html
138 index.html
139 index.xml
140 sitemap.xml
141 posts/
142 posts/index.html
143
144 sent 9,550 bytes received 1,708 bytes 7,505.33 bytes/sec
145 total size is 966,557 speedup is 85.86
146 ```
147
148 You can incorporate other proprocessing tasks into this deployment script as well.