Deploy Site

Hugo generates static websites, allowing for flexible hosting options. This page provides guides for deploying your Hextra site on various platforms.

GitHub Pages

GitHub Pages is the recommended way to deploy and host your website for free.

If you bootstrap the site using hextra-starter-template, it has provided GitHub Actions workflow out-of-the-box that helps automatically deploy to GitHub Pages.

GitHub Actions Configuration

Below is an example configuration from hextra-starter-template:

.github/workflows/pages.yaml
# Sample workflow for building and deploying a Hugo site to GitHub Pages
name: Deploy Hugo site to Pages

on:
  # Runs on pushes targeting the default branch
  push:
    branches: ["main"]

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
  group: "pages"
  cancel-in-progress: false

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  # Build job
  build:
    runs-on: ubuntu-latest
    env:
      HUGO_VERSION: 0.117.0
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0    # Fetch all history for .GitInfo and .Lastmod
      - name: Setup Go
        uses: actions/setup-go@v4
        with:
          go-version: '1.21'
      - name: Setup Hugo
        uses: peaceiris/actions-hugo@v2
        with:
          hugo-version: '0.117.0'
          extended: true
      - name: Build with Hugo
        env:
          # For maximum backward compatibility with Hugo modules
          HUGO_ENVIRONMENT: production
          HUGO_ENV: production
        run: |
          hugo \
            --gc --minify \
            --baseURL "https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/"          
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v2
        with:
          path: ./public

  # Deployment job
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2
In your repository settings, set the Pages > Build and deployment > Source to GitHub Actions:

By default, the above GitHub Actions workflow .github/workflows/pages.yaml assumes that the site is deploying to https://<USERNAME>.github.io/<REPO>/.

If you are deploying to https://<USERNAME>.github.io/ then modify the --baseURL:

.github/workflows/pages.yaml
54
55
56
57
run: |
  hugo \
    --gc --minify \
    --baseURL "https://${{ github.repository_owner }}.github.io/"  

If you are deploying to your own domain, please change the --baseURL value accordingly.

Cloudflare Pages

  1. Put your site source code in a Git repository (e.g. GitHub)
  2. Log in to the Cloudflare dashboard and select your account
  3. In Account Home, select Workers & Pages > Create application > Pages > Connect to Git
  4. Select the repository, and in the Set up builds and deployments section, provide the following information:
ConfigurationValue
Production branchmain
Build commandhugo --gc --minify
Build directorypublic

For more details, check out:

Netlify

  1. Push your code to your Git repository (GitHub, GitLab, etc.)
  2. Import the project to Netlify
  3. If you are not using [hextra-starter-template][hextra-starter-template], configure the following manually:
    • Configure the Build command to hugo --gc --minify
    • Specify the Publish directory to public
    • Add Environment variable HUGO_VERSION and set to 0.119.0
  4. Deploy!

Check Hugo on Netlify for more details.

Vercel

  1. Push your code to your Git repository (GitHub, GitLab, etc.)
  2. Go to Vercel Dashboard and import your Hugo project
  3. Configure the project, select Hugo as Framework Preset
  4. Override the Build Command and Install command:
    1. Set Build Command to hugo --gc --minify
    2. Set Install Command to yum install golang

Vercel Deployment Configuration

Last updated on