# Hosting and deployment

Deploy your Hinode site to popular hosting providers.

As a static website, your Hinode site can be deployed virtually anywhere. Hugo provides a comprehensive overview of the more popular [deployment solutions](https://gohugo.io/hosting-and-deployment). Hinode uses a different build process compared to a default Hugo site. Review the [considerations](#considerations) for more details. The next paragraphs highlight the specific build and deployment process of Hinode for a few selected hosting providers.

## Considerations

Before deciding on your hosting and deployment approach, review the following considerations.

1. **Include npm in your build process**

   Hinode supports npm to automate the build process. Visit the [Hinode introduction](introduction) and [commands overview](commands) for more details.

2. **Configure the build timeout**

   You might encounter timeout errors when you generate a large site that contains many resources (such as images). Adjust the `timeout` in `config/_default/hugo.toml` as needed.

   ```toml
timeout = "180s"
```

3. **Consider using build automation**

   Many popular Git providers provide the option to automate the build and deployment process (CI/CD (Continuous Integration/Continuous Deployment)
). You can trigger this process on each release to your main repository branch, or set up a preview during a Pull Request. The examples on this page assume you have a Git repository with GitHub.

4. **Understand the support for custom domain names**

   Most hosting providers provide a subdomain, such as `<username>.github.io`, to access your website by default. Usually you have the ability to use a custom domain instead, although additional services and configuration might be needed.

5. **Decide on multiregion and CDN support**

   Websites that serve a global audience might benefit from a multiregion or edge deployment to increase availability and reduce latency. You can also consider adding a dedicated CDN (Content Delivery Network)
, which has the ability to reduce the impact of DDoS (Distributed Denial of Service)
 attacks for example.

6. **Consider using custom HTTP headers**

   Hinode uses custom HTTP headers to enable the [Content Security Policy](server-headers). The support for custom HTTP headers varies per provider, and might need additional services and configuration.

The table below gives a brief overview of the features supported by a few selected hosting providers. The next paragraphs describe the build and deployment process for each provider in more detail.

| Feature            | Azure blob storage | Netlify               |
|--------------------|--------------------|-----------------------|
| Automation         | Custom action      | {{< fas check >}} |
| Custom domain name | Requires Azure CDN | {{< fas check >}} |
| CDN / Edge network | Requires Azure CDN | {{< fas check >}} |
| HTTP headers       | Requires Azure CDN | {{< fas check >}} |

## Host on Azure blob storage

Azure supports hosting a static website directly from its blob storage. The service is [available for free](https://azure.microsoft.com/en-us/free) for the first 12 months (conditions apply). The next sections describe how to configure the cloud storage correctly and how to deploy your website from your local computer to Azure.

### Assumptions

- You have a Hinode website you are ready to deploy.
- You do not already have an Azure storage account.

### Preparations

The configuration folder should include a file `config/production/deployment.toml`. If not, copy it from the [Hinode main repository](https://github.com/gethinode/hinode). The deployment file contains the settings used by the command `hugo deploy`. The panel below shows the default deployment settings for Azure blob storage. A more detailed example is available on the [Hugo website](https://gohugo.io/hosting-and-deployment/hugo-deploy/#configure-the-deployment).

```toml
# By default, files are uploaded in an arbitrary order.
# Files that match the regular expressions in the "Order" list
# will be uploaded first, in the listed order.
order = [".webp$", ".jpg$", ".gif$"]

[targets]
name = "hinode"
URL = "azblob://$web"

[[matchers]]
# Cache static assets for 1 year.
pattern = "^.+\\.(js|css|svg|ttf)$"
cacheControl = "max-age=31536000, no-transform, public"
gzip = true

[[matchers]]
pattern = "^.+\\.(png|jpg|webp)$"
cacheControl = "max-age=31536000, no-transform, public"
gzip = false

[[matchers]]
# Set custom content type for /sitemap.xml
pattern = "^sitemap\\.xml$"
contentType = "application/xml"
gzip = true

[[matchers]]
pattern = "^.+\\.(html|xml|json)$"
gzip = true
```

### Configure your site

Deploy your site to Azure blob storage in six steps.

  ![Step 1a. Create a storage account](img/azblob-step1a.png)

  ![Step 1b. Define the instance details](img/azblob-step1b.png)

  ![Step 1c. Confirm the storage account deployment](img/azblob-step1c.png)

  ![Step 2. Enable the static website](img/azblob-step2.png)

  ![Step 3. Configure environment variables](img/azblob-step3.png)

{{< /carousel >}}

  ### Step 1. Create a storage account

If not done so already, sign up for an account on the [Azure website](https://azure.microsoft.com). Log in to the Azure portal and create a storage account. The storage account needs to have a unique name across Azure. Select a region that best fits your needs. Leave all other options to their default value.

  ### Step 2. Enable the static website

Go to the menu section `Data management` and select `Static website`. Set the toggle for `Static website` to `Enabled`. Azure will then create a storage container `$web` within your storage account to host your website. Capture the primary endpoint, for example `https://gethinode.z6.web.core.windows.net/`. Set the `Index document name` to `index.html`. Hit the `Save` button when done.

  ### Step 3. Configure environment variables

Go to the menu section `Security + networking` and select `Access keys`. Capture the storage account name, e.g. `gethinode`. Next, copy either of the two keys to your clipboard. Set the credentials on your local computer:
    {{< command user="user" host="localhost" >}}
    export AZURE_STORAGE_ACCOUNT="{account name}"
    export AZURE_STORAGE_KEY="{storage key}"
    {{< /command >}}

  ### Step 4. Build the website locally

Run the following command to build your website locally using `hugo`:
      {{< command user="hugo" host="localhost" >}}
      hugo mod get -u ./... && hugo mod tidy && hugo --gc --minify
      {{< /command >}}
    Alternatively, use the following command when using `npm`:
      {{< command user="npm" host="localhost" >}}
      npm install && npm run mod:update && npm run build
      {{< /command >}}

  ### Step 5. Deploy the files

Deploy the files to your Azure blob storage using the following command. Add `--dryRun` to review the upload before actually publishing the files.
    {{< command user="user" host="localhost" >}}
    hugo deploy
    {{< /command >}}

  ### Step 6. Visit the end point

Once the deployment has finished, visit the end point captured in step 2 to test the website in your browser.

You can make your static website available via a custom domain. Visit the [Azure documentation](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-custom-domain-name) on how to map a custom domain to your blob storage endpoint. The static website does not support configuration of HTTP headers. Use Azure CDN to [configure HTTP headers](https://learn.microsoft.com/en-us/azure/cdn/cdn-standard-rules-engine-reference) for your static website instead. Review the [server configuration](server-headers) to identify the recommended configuration of the Content Security Policy.

## Host on Netlify

Netlify can host your website with continuous deployment from your Git provider. The starter price plan is free for any public repository and provides 100 GB bandwidth and 300 build minutes each month. Review the next sections on how to automatically deploy your site to Netlify on each update to the main branch of your repository.

> [!NOTE]
> The starter plan requires your repository to be public. You will require a paid plan if your repository is set to private.

### Assumptions

- You have an account and repository with GitHub, GitLab, or Bitbucket.
- You have a Hinode website you are ready to deploy.
- You do not already have a Netlify account.

### Preparations

The repository root should include a file `netlify.toml`. If not, copy it from the [Hinode main repository](https://github.com/gethinode/hinode). The configuration file contains the build settings that Netlify will pick up when connecting to your repository. The panel below shows the default build settings. The key command to observe is `npm run build`, which ensures the site is built properly.

> [!NOTE]
> The default configuration provides basic security headers. Please review the [server configuration](server-headers) for more details about the Content Security Policy. The cache settings are explained in more detail in the [Netlify blog](https://www.netlify.com/blog/2017/02/23/better-living-through-caching/).

```toml
[build]
    publish = "exampleSite/public"
    command = "HUGO_HINODE_VERSION=$(git describe --tags $(git rev-list --tags --max-count=1)) npm run build:example"

[build.environment]
    DART_SASS_VERSION = "1.98.0"
    HUGO_VERSION = "0.153.1"
    HUGO_ENV = "production"
    HUGO_ENABLEGITINFO = "true"
    NODE_VERSION = "24.12.0"
    NPM_VERSION = "11.6.2"
```

The same file also configures several optional plugins. Keep these plugins if you would like to support [Dart Sass](docs/configuration/layout#extended-configuration)
, use caching, and generate a Lighthouse report upon each build.

```toml
[[plugins]]
    package = "netlify-plugin-hugo-cache-resources"
```

### Configure your site

Sign up for Netlify and configure your site in seven steps.

  ![Step 1. Sign up for Netlify](img/netlify-step1.png)

  ![Step 2. Sign in with your Git provider](img/netlify-step2.png)

  ![Step 3. Authenticate your sign in (2FA)](img/netlify-step3.png)

  ![Step 4. Add a new site](img/netlify-step4.png)

  ![Step 5. Connect to your Git provider](img/netlify-step5.png)

  ![Step 6. Import an existing project](img/netlify-step6.png)

  ![Step 7. Configure the build settings](img/netlify-step7.png)

{{< /carousel >}}

  ### Step 1. Sign up for Netlify

Go to [netlify.com](https://www.netlify.com) and click on the button `Sign up`. Select your preferred signup method next. This will likely be a hosted Git provider, although you also have the option to sign up with an email address. The next steps use GitHub, but other Git providers will follow a similar process.

  ### Step 2. Sign in with your Git provider

Enter the credentials for your Git provider and click the button to sign in.

  ### Step 3. Authenticate your sign in (2FA)

Assuming you have enabled two-factor authentication with your Git provider, authenticate the sign in next. This example uses the GitHub Mobile app.

  ### Step 4. Add a new site

Click on the button `Add new site` to set up a new site with Netlify.

  ### Step 5. Connect to your Git provider

Connect to your Git provider to import your existing Hinode repository.

  ### Step 6. Import an existing project

Pick a repository from your Git provider. Ensure Netlify has access to the correct repository.

  ### Step 7. Configure the build settings

Review the basic build settings. Netlify will use the settings provided in the [preparations](#preparations-1). Click on the button `Deploy site` to start the build and deployment process.

Your site is now ready to be used. Click on the domain settings of your site within the `Site overview` page to provide a domain alias and to edit the site name as needed. The same section also allows the configuration of a custom domain. Be sure to review your [server configuration](server-headers) if you encounter any rendering issues, such as broken links or garbled stylesheets.