![Bjørn Erik Pedersen](/assets/img/avatar_default.png)
4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
9.5 KiB
title | description | categories | keywords | menu | weight | toc | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Hugo Deploy | Upload your site to GCS, S3, or Azure |
|
|
|
20 | true |
You can use the "hugo deploy" command to upload your site directly to a Google Cloud Storage (GCS) bucket, an AWS S3 bucket, and/or an Azure Storage container.
Assumptions
- You have completed the Quick Start or have a Hugo website you are ready to deploy and share with the world.
- You have an account with the service provider (Google Cloud, AWS, or Azure) that you want to deploy to.
- You have authenticated.
- Google Cloud: Install the CLI and run
gcloud auth login
. - AWS: Install the CLI and run
aws configure
. - Azure: Install the CLI and run
az login
. - NOTE: Each service supports alternatives for authentication, including using environment variables. See here for more details.
- Google Cloud: Install the CLI and run
- You have created a bucket to deploy to. If you want your site to be
public, be sure to configure the bucket to be publicly readable as a static website.
- Google Cloud: create a bucket and host a static website
- Amazon S3: create a bucket and host a static website
- Microsoft Azure: create a storage container and host a static website
Configuring your first deployment
In the configuration file for your site, add a [deployment]
section
and a [[deployment.targets]]
subsection. The only required parameters are
the name and URL:
[deployment]
[[deployment.targets]]
# An arbitrary name for this target.
name = "production"
# URL specifies the Go Cloud Development Kit URL to deploy to. Examples:
URL = "<FILL ME IN>"
# Google Cloud Storage -- see https://gocloud.dev/howto/blob/#gcs
#URL = "gs://<Bucket Name>"
# Amazon Web Services S3; see https://gocloud.dev/howto/blob/#s3
# For S3-compatible endpoints, see https://gocloud.dev/howto/blob/#s3-compatible
#URL = "s3://<Bucket Name>?region=<AWS region>"
# Microsoft Azure Blob Storage; see https://gocloud.dev/howto/blob/#azure
#URL = "azblob://$web"
Deploy
To deploy to a target:
hugo deploy [--target=<target name>]
The deploy process recursively walks through your local publish directory
(public
by default) and syncs it to the destination bucket, to ensure
that the local and remote contents match.
If you don't specify a target, Hugo will deploy to the first target in your configuration.
See hugo help deploy
or the deploy command-line documentation for more command-line options.
How the file list works
The first thing hugo deploy
does is create file lists for local and remote by
traversing the local publish directory and remote bucket.
For both local and remote, the file list includes and excludes files according to the deployment target's configuration --
- If the configuration specifies an
include
pattern, all files are skipped by default except those matching the pattern. - If the configuration specifies an
exclude
pattern, files matching the pattern are skipped.
{{% note %}}
When creating the local file list, a few additional skips apply: first, Hugo always
skips files named .DS_Store
.
Second, Hugo always skips local hidden directories
(directories with names starting with a period, e.g. .git
) and does not
traverse into them, except for the special hidden directory named
.well-known
, which is
traversed if it exists.
{{% /note %}}
How the local and remote file lists are compared
In the second step, Hugo compares the two file lists to figure out what changes actually need to be made on the remote. File names are compared first; if the local and remote files both exist then the sizes and md5sums are compared. Any difference means that the file will be (re-)uploaded.
Specifying the --force
flag will ensure all files are re-uploaded even
if Hugo cannot detect any differences between local and remote.
Files are deleted from the remote bucket if they are not present in the local file list.
{{% note %}} If a remote file is excluded from the file list generation using the exclude/include configs, then the comparison step will not know to delete the file -- so it will remain on the remote even if it isn't present locally. {{% /note %}}
If the --confirm
or --dryRun
flags are given, Hugo displays
what differences it has found and either pauses or stops here.
How synchronization works
Hugo applies the list of changes to the remote storage bucket. Missing and/or changed files are uploaded, and files missing locally but present remotely are deleted. As files are uploaded, their headers are also configured on the remote according to the matchers configuration.
{{% note %}}
As a safety measure to help prevent accidents, if there are more than 256 files
to delete, Hugo won't delete any files from the remote. Use the --maxDeletes
command line flag to override this.
{{% /note %}}
Advanced configuration
Here's a full example deployment configuration:
[deployment]
# By default, files are uploaded in an arbitrary order.
# If you specify an `order` list, files that match regular expressions
# in this list will be uploaded first, in the specified order.
order = [".jpg$", ".gif$"]
[[deployment.targets]]
# Define one or more targets, e.g., staging and production.
# Each target gets its own [[deployment.targets]] section.
# An arbitrary name for this target.
name = "mydeployment"
# The Go Cloud Development Kit URL to deploy to. Examples:
URL = "<FILL ME IN>"
# GCS; see https://gocloud.dev/howto/blob/#gcs
#URL = "gs://<Bucket Name>"
# S3; see https://gocloud.dev/howto/blob/#s3
# For S3-compatible endpoints, see https://gocloud.dev/howto/blob/#s3-compatible
#URL = "s3://<Bucket Name>?region=<AWS region>"
# Azure Blob Storage; see https://gocloud.dev/howto/blob/#azure
#URL = "azblob://$web"
# You can use a "prefix=" query parameter to target a subfolder of the bucket:
#URL = "gs://<Bucket Name>?prefix=a/subfolder/"
# If you are using a CloudFront CDN, deploy will invalidate the cache as needed.
#cloudFrontDistributionID = "<FILL ME IN>"
# Include or exclude specific files when deploying to this target:
# If exclude is non-empty, and a local or remote file's path matches it, that file is not synced.
# If include is non-empty, and a local or remote file's path does not match it, that file is not synced.
# Note: local files that don't pass the include/exclude filters are not uploaded to remote,
# and remote files that don't pass the include/exclude filters are not deleted.
#
# The pattern syntax is documented here: https://godoc.org/github.com/gobwas/glob#Glob
# Patterns should be written with forward slashes as separator.
#
#include = "**.html" # would only include files with ".html" suffix
#exclude = "**.{jpg, png}" # would exclude files with ".jpg" or ".png" suffix
#######################
[[deployment.matchers]]
# Matchers enable special caching, content type and compression behavior for
# specified file types. You can include any number of matcher blocks; the first one
# matching a given file pattern will be used.
# See https://golang.org/pkg/regexp/syntax/ for pattern syntax.
# Pattern searching is stopped on first match.
pattern = "<FILL ME IN>"
# If true, Hugo will gzip the file before uploading it to the bucket.
# With many storage services, this will save on storage and bandwidth costs
# for uncompressed file types.
#gzip = false
# If true, Hugo always re-uploads this file even if size and md5 match.
# This is useful if Hugo isn't reliably able to determine whether to re-upload
# the file on its own.
#force = false
# Content-type header to configure for this file when served.
# By default this can be determined from the file extension.
#contentType = ""
# Cache-control header to configure for this file when served.
# The default is the empty string.
#cacheControl = ""
# Content-encoding header to configure for this file when served.
# By default, if gzip is True, this will be filled with "gzip".
#contentEncoding = ""
# Samples:
[[deployment.matchers]]
# Cache static assets for 1 year.
pattern = "^.+\\.(js|css|svg|ttf)$"
cacheControl = "max-age=31536000, no-transform, public"
gzip = true
[[deployment.matchers]]
pattern = "^.+\\.(png|jpg)$"
cacheControl = "max-age=31536000, no-transform, public"
gzip = false
[[deployment.matchers]]
# Set custom content type for /sitemap.xml
pattern = "^sitemap\\.xml$"
contentType = "application/xml"
gzip = true
[[deployment.matchers]]
pattern = "^.+\\.(html|xml|json)$"
gzip = true