Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugoDocs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel F. Dickinson <daniel@wildtechgarden.ca>2022-03-26 20:10:45 +0300
committerGitHub <noreply@github.com>2022-03-26 20:10:45 +0300
commitb53eb5a086df3c1f4246f42894f5eecc83f861a9 (patch)
tree0c1cdf6eb85ddad120bb22335f199de0beff9650
parent4207c57ffe0ae9f98212a8e3c183f48e51109f11 (diff)
Add page for deploying with rclone (#1511)
Rclone is a multi-protocol file copy and and sync tool that can make deploying static websites a breeze. This commit adds a brief guide to using Rclone to deploy sites generated with Hugo. Signed-off-by: Daniel F. Dickinson <20735818+danielfdickinson@users.noreply.github.com>
-rw-r--r--content/en/hosting-and-deployment/deployment-with-rclone.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/content/en/hosting-and-deployment/deployment-with-rclone.md b/content/en/hosting-and-deployment/deployment-with-rclone.md
new file mode 100644
index 000000000..e9feb765a
--- /dev/null
+++ b/content/en/hosting-and-deployment/deployment-with-rclone.md
@@ -0,0 +1,57 @@
+---
+title: Deployment with Rclone
+linktitle: Deployment with Rclone
+description: If you have access to your web host with SFTP/FTP/SSH/HTTP(DAV), you can use rclone to incrementally deploy your entire Hugo website.
+date: 2021-08-09
+publishdate: 2021-08-09
+lastmod: 2021-08-09
+categories: [hosting and deployment]
+keywords: [rclone,sftp,deployment]
+authors: [Daniel F. Dickinson]
+menu:
+ docs:
+ parent: "hosting-and-deployment"
+ weight: 80
+weight: 80
+sections_weight: 80
+draft: false
+aliases: [/tutorials/deployment-with-rclone/]
+toc: true
+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 any of the [protocols supported by rclone](https://rclone.org/#providers), such as SFTP.
+* A functional static website built with Hugo
+* Deploying from an [Rclone](https://rclone.org) compatible operating system
+* You have [installed Rclone](https://rclone.org/install/).
+
+**NB**: You can remove ``--interactive`` in the commands below once you are comfortable with rclone, if you wish. Also, ``--gc`` and ``--minify`` are optional in the ``hugo`` commands below.
+
+## Getting Started
+
+The spoiler is that you can even deploy your entire website from any compatible OS with no configuration. Using SFTP for example:
+
+```
+hugo --gc --minify
+rclone sync --interactive --sftp-host sftp.example.com --sftp-user www-data --sftp-ask-password public/ :sftp:www/
+```
+
+## Configure Rclone for Even Easier Usage
+
+The easiest way is simply to run ``rclone config``.
+
+The [Rclone docs](https://rclone.org/docs/) provide [an example of configuring Rclone to use SFTP](https://rclone.org/sftp/).
+
+For the next commands, we will assume you configured a remote you named ``hugo-www``
+
+The above 'spoiler' commands could become:
+
+```
+hugo --gc --minify
+rclone sync --interactive public/ hugo-www:www/
+```
+
+After you issue the above commands (and respond to any prompts), check your website and you will see that it is deployed.