https://github.com/nathany/hugo-deploy

Example deployment to S3 for Hugo blogs.
https://github.com/nathany/hugo-deploy

amazon-s3 deploy hugo static-site

Last synced: 3 months ago
JSON representation

Example deployment to S3 for Hugo blogs.

• Host: GitHub
• URL: https://github.com/nathany/hugo-deploy
• Owner: nathany
• License: bsd-2-clause
• Created: 2015-02-28T21:12:02.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2021-02-22T02:47:40.000Z (almost 4 years ago)
• Last Synced: 2024-04-17T05:49:34.144Z (10 months ago)
• Topics: amazon-s3, deploy, hugo, static-site
• Language: HTML
• Homepage: http://hugo-deploy-example.s3-website.ca-central-1.amazonaws.com/
• Size: 35.2 KB
• Stars: 77
• Watchers: 3
• Forks: 7
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hugo Deploy

This is an starting point for a [Hugo](https://gohugo.io/) blog with deployment to [Amazon S3](https://aws.amazon.com/s3/) via [GitHub Actions](https://github.com/features/actions).

It's how I deploy [nathany.com](https://nathany.com/), [Edmonton Go](https://edmontongo.org/), and [fsnotify.org](https://fsnotify.org/).

## Requirements

Local development:

* Install the `hugo` binary, download it at [gohugo.io](https://gohugo.io/).

  * On Mac use [Homebrew](https://brew.sh/): `brew install hugo`

Remote:

* A GitHub account with the contents of your website (free).

* An Amazon account to create an S3 bucket (pennies).

* DNS configured to point to S3. 

    * [CloudFlare](https://www.cloudflare.com/) is recommend for HTTPS (free).

## What Is Provided?

* `hugo new site ` creates a config.toml and a few empty folders. I've added .gitkeep files so those folders are checked in.

* An `assets/sass` folder with `all.sass` that will be converted to css.

* A script to watch for file changes in development and include drafts in the output. Run `./watch.sh`.

* `.gitignore` to avoid committing the generated files.

* Workflow file that GitHub Actions uses for deployment (`.github/workflows/build.yml`).

### Deployment

GitHub Actions automatically deploy the website when changes are merged to the master branch on GitHub. In my experience, deploys take a few seconds to complete.

* [hugo-deploy-example.s3-website.ca-central-1.amazonaws.com](http://hugo-deploy-example.s3-website.ca-central-1.amazonaws.com) is the website endpoint on Amazon S3.

This [bucket policy provides public access](https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteAccessPermissionsReqd.html) to the files in S3.

```

{

    "Version": "2012-10-17",

    "Statement": [

        {

            "Sid": "PublicReadGetObject",

            "Effect": "Allow",

            "Principal": "*",

            "Action": [

                "s3:GetObject"

            ],

            "Resource": [

                "arn:aws:s3:::hugo-deploy-example/*"

            ]

        }

    ]

}

```