hugo/docs/content/en/host-and-deploy/host-on-netlify/index.md
Bjørn Erik Pedersen 61a286595e
Some checks are pending
Test / test (1.23.x, ubuntu-latest) (push) Waiting to run
Test / test (1.23.x, windows-latest) (push) Waiting to run
Test / test (1.24.x, ubuntu-latest) (push) Waiting to run
Test / test (1.24.x, windows-latest) (push) Waiting to run
Merge commit 'b3d87dd0fd'
2025-04-24 10:23:16 +02:00

146 lines
3.8 KiB
Markdown

---
title: Host on Netlify
description: Host your site on Netlify.
categories: []
keywords: []
aliases: [/hosting-and-deployment/hosting-on-netlify/]
---
## Prerequisites
Please complete the following tasks before continuing:
1. [Create a Netlify account]
1. [Install Git]
1. [Create a Hugo site] and test it locally with `hugo server`
1. Commit the changes to your local repository
1. Push the local repository to your [GitHub], [GitLab], or [Bitbucket] account
[Bitbucket]: https://bitbucket.org/product
[Create a Hugo site]: /getting-started/quick-start/
[Create a Netlify account]: https://app.netlify.com/signup
[GitHub]: https://github.com
[GitLab]: https://about.gitlab.com/
[Install Git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
## Procedure
This procedure will enable continuous deployment from a GitHub repository. The procedure is essentially the same if you are using GitLab or Bitbucket.
### Step 1
Log in to your Netlify account, navigate to the Sites page, press the **Add new site** button, and choose "Import an existing project" from the dropdown menu.
### Step 2
Select your deployment method.
![screen capture](netlify-step-02.png)
### Step 3
Authorize Netlify to connect with your GitHub account by pressing the **Authorize Netlify** button.
![screen capture](netlify-step-03.png)
### Step 4
Press the **Configure Netlify on GitHub** button.
![screen capture](netlify-step-04.png)
### Step 5
Install the Netlify app by selecting your GitHub account.
![screen capture](netlify-step-05.png)
### Step 6
Press the **Install** button.
![screen capture](netlify-step-06.png)
### Step 7
Click on the site's repository from the list.
![screen capture](netlify-step-07.png)
### Step 8
Set the site name and branch from which to deploy.
![screen capture](netlify-step-08.png)
### Step 9
Define the build settings, press the **Add environment variables** button, then press the **New variable** button.
![screen capture](netlify-step-09.png)
### Step 10
Create a new environment variable named `HUGO_VERSION` and set the value to the [latest version].
[latest version]: https://github.com/gohugoio/hugo/releases/latest
![screen capture](netlify-step-10.png)
### Step 11
Press the "Deploy my new site" button at the bottom of the page.
![screen capture](netlify-step-11.png)
### Step 12
At the bottom of the screen, wait for the deploy to complete, then click on the deploy log entry.
![screen capture](netlify-step-12.png)
### Step 13
Press the **Open production deploy** button to view the live site.
![screen capture](netlify-step-13.png)
## Configuration file
In the procedure above we configured our site using the Netlify user interface. Most site owners find it easier to use a configuration file checked into source control.
Create a new file named netlify.toml in the root of your project directory. In its simplest form, the configuration file might look like this:
```toml {file="netlify.toml"}
[build.environment]
GO_VERSION = "1.24"
HUGO_VERSION = "0.146.7"
NODE_VERSION = "22"
TZ = "America/Los_Angeles"
[build]
publish = "public"
command = "git config core.quotepath false && hugo --gc --minify"
```
If your site requires Dart Sass to transpile Sass to CSS, the configuration file should look something like this:
```toml {file="netlify.toml"}
[build.environment]
DART_SASS_VERSION = "1.87.0"
GO_VERSION = "1.24"
HUGO_VERSION = "0.146.7"
NODE_VERSION = "22"
TZ = "America/Los_Angeles"
[build]
publish = "public"
command = """\
curl -LJO https://github.com/sass/dart-sass/releases/download/${DART_SASS_VERSION}/dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
tar -xf dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
rm dart-sass-${DART_SASS_VERSION}-linux-x64.tar.gz && \
export PATH=/opt/build/repo/dart-sass:$PATH && \
git config core.quotepath false && \
hugo --gc --minify \
"""
```