hugo/content/en/getting-started/installing.md at b9bd35d72e14932fb6588ff62b90cddef0a060fc

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00

Bjørn Erik Pedersen b9bd35d72e Squashed 'docs/' content from commit fdea5430f

git-subtree-dir: docs
git-subtree-split: fdea5430f89dfd849d39212abdf5ace0a4763e5a

2019-10-21 10:22:28 +02:00

22 KiB

Raw Blame History

title

linktitle

description

date

publishdate

lastmod

Quick Install

Binary (Cross-platform)

Download the appropriate version for your platform from Hugo Releases. Once downloaded, the binary can be run from anywhere. You don't need to install it into a global location. This works well for shared hosts and other systems where you don't have a privileged account.

Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

Homebrew (macOS)

If you are on macOS and using Homebrew, you can install Hugo with the following one-liner:

{{< code file="install-with-homebrew.sh" >}} brew install hugo {{< /code >}}

For more detailed explanations, read the installation guides that follow for installing on macOS and Windows.

Linuxbrew (Linux)

If you are on Linux and using Linuxbrew, you can install Hugo with the following one-liner:

{{< code file="install-with-linuxbrew.sh" >}} brew install hugo {{< /code >}}

Installation guides for Linuxbrew are available on their website.

Chocolatey (Windows)

If you are on a Windows machine and use Chocolatey for package management, you can install Hugo with the following one-liner:

{{< code file="install-with-chocolatey.ps1" >}} choco install hugo -confirm {{< /code >}}

Scoop (Windows)

If you are on a Windows machine and use Scoop for package management, you can install Hugo with the following one-liner:

scoop install hugo

Source

Prerequisite Tools

Fetch from GitHub

Since Hugo 0.48, Hugo uses the Go Modules support built into Go 1.11 to build. The easiest way to get started is to clone Hugo in a directory outside of the GOPATH, as in the following example:

{{< code file="from-gh.sh" >}} mkdir $HOME/src cd $HOME/src git clone https://github.com/gohugoio/hugo.git cd hugo go install --tags extended {{< /code >}}

Remove --tags extended if you do not want/need Sass/SCSS support.

{{% note %}} If you are a Windows user, substitute the $HOME environment variable above with %USERPROFILE%. {{% /note %}}

macOS

Assumptions

You know how to open the macOS terminal.
You're running a modern 64-bit Mac.
You will use ~/Sites as the starting point for your site. (~/Sites is used for example purposes. If you are familiar enough with the command line and file system, you should have no issues following along with the instructions.)

Pick Your Method

There are three ways to install Hugo on your Mac

The Homebrew brew utility
Distribution (i.e., tarball)
Building from Source

There is no "best" way to install Hugo on your Mac. You should use the method that works best for your use case.

Pros and Cons

There are pros and cons to each of the aforementioned methods:

Homebrew. Homebrew is the simplest method and will require the least amount of work to maintain. The drawbacks aren't severe. The default package will be for the most recent release, so it will not have bug fixes until the next release (i.e., unless you install it with the --HEAD option). Hugo brew releases may lag a few days behind because it has to be coordinated with another team. Nevertheless, brew is the recommended installation method if you want to work from a stable, widely used source. Brew works well and is easy to update.
Tarball. Downloading and installing from the tarball is also easy, although it requires a few more command line skills than does Homebrew. Updates are easy as well: you just repeat the process with the new binary. This gives you the flexibility to have multiple versions on your computer. If you don't want to use brew, then the tarball/binary is a good choice.
Building from Source. Building from source is the most work. The advantage of building from source is that you don't have to wait for a release to add features or bug fixes. The disadvantage is that you need to spend more time managing the setup, which is manageable but requires more time than the preceding two options.

{{% note %}} Since building from source is appealing to more seasoned command line users, this guide will focus more on installing Hugo via Homebrew and Tarball. {{% /note %}}

Install Hugo with Brew

Step 1: Install `brew` if you haven't already

Go to the brew website, https://brew.sh/, and follow the directions there. The most important step is the installation from the command line:

{{< code file="install-brew.sh" >}} ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" {{< /code >}}

Step 2: Run the `brew` Command to Install `hugo`

Installing Hugo using brew is as easy as the following:

{{< code file="install-brew.sh" >}} brew install hugo {{< /code >}}

If Homebrew is working properly, you should see something similar to the following:

==> Downloading https://homebrew.bintray.com/bottles/hugo-0.21.sierra.bottle.tar.gz
######################################################################### 100.0%
==> Pouring hugo-0.21.sierra.bottle.tar.gz
🍺  /usr/local/Cellar/hugo/0.21: 32 files, 17.4MB

{{% note "Installing the Latest Hugo with Brew" %}} Replace brew install hugo with brew install hugo --HEAD if you want the absolute latest in-development version. {{% /note %}}

brew should have updated your path to include Hugo. You can confirm by opening a new terminal window and running a few commands:

$ # show the location of the hugo executable
which hugo
/usr/local/bin/hugo

# show the installed version
ls -l $( which hugo )
lrwxr-xr-x  1 mdhender admin  30 Mar 28 22:19 /usr/local/bin/hugo -> ../Cellar/hugo/0.13_1/bin/hugo

# verify that hugo runs correctly
hugo version
Hugo Static Site Generator v0.13 BuildDate: 2015-03-09T21:34:47-05:00

Install Hugo from Tarball

Step 1: Decide on the location

When installing from the tarball, you have to decide if you're going to install the binary in /usr/local/bin or in your home directory. There are three camps on this:

Install it in /usr/local/bin so that all the users on your system have access to it. This is a good idea because it's a fairly standard place for executables. The downside is that you may need elevated privileges to put software into that location. Also, if there are multiple users on your system, they will all run the same version. Sometimes this can be an issue if you want to try out a new release.
Install it in ~/bin so that only you can execute it. This is a good idea because it's easy to do, easy to maintain, and doesn't require elevated privileges. The downside is that only you can run Hugo. If there are other users on your site, they have to maintain their own copies. That can lead to people running different versions. Of course, this does make it easier for you to experiment with different releases.
Install it in your Sites directory. This is not a bad idea if you have only one site that you're building. It keeps every thing in a single place. If you want to try out new releases, you can make a copy of the entire site and update the Hugo executable.

All three locations will work for you. In the interest of brevity, this guide focuses on option #2.

Step 2: Download the Tarball

Open https://github.com/gohugoio/hugo/releases in your browser.
Find the current release by scrolling down and looking for the green tag that reads "Latest Release."
Download the current tarball for the Mac. The name will be something like hugo_X.Y_osx-64bit.tgz, where X.YY is the release number.
By default, the tarball will be saved to your ~/Downloads directory. If you choose to use a different location, you'll need to change that in the following steps.

Step 3: Confirm your download

Verify that the tarball wasn't corrupted during the download:

tar tvf ~/Downloads/hugo_X.Y_osx-64bit.tgz
-rwxrwxrwx  0 0      0           0 Feb 22 04:02 hugo_X.Y_osx-64bit/hugo_X.Y_osx-64bit.tgz
-rwxrwxrwx  0 0      0           0 Feb 22 03:24 hugo_X.Y_osx-64bit/README.md
-rwxrwxrwx  0 0      0           0 Jan 30 18:48 hugo_X.Y_osx-64bit/LICENSE.md

The .md files are documentation for Hugo. The other file is the executable.

Step 4: Install Into Your `bin` Directory

# create the directory if needed
mkdir -p ~/bin

# make it the working directory
cd ~/bin

# extract the tarball
tar -xvzf ~/Downloads/hugo_X.Y_osx-64bit.tgz
Archive:  hugo_X.Y_osx-64bit.tgz
  x ./
  x ./hugo
  x ./LICENSE.md
  x ./README.md

# verify that it runs
./hugo version
Hugo Static Site Generator v0.13 BuildDate: 2015-02-22T04:02:30-06:00

You may need to add your bin directory to your PATH variable. The which command will check for us. If it can find hugo, it will print the full path to it. Otherwise, it will not print anything.

# check if hugo is in the path
which hugo
/Users/USERNAME/bin/hugo

If hugo is not in your PATH, add it by updating your ~/.bash_profile file. First, start up an editor:

nano ~/.bash_profile

Add a line to update your PATH variable:

export PATH=$PATH:$HOME/bin

Then save the file by pressing Control-X, then Y to save the file and return to the prompt.

Close the terminal and open a new terminal to pick up the changes to your profile. Verify your success by running the which hugo command again.

You've successfully installed Hugo.

Build from Source on Mac

If you want to compile Hugo yourself, you'll need to install Go (aka Golang). You can install Go directly from the Go website or via Homebrew using the following command:

brew install go

Step 1: Get the Source

If you want to compile a specific version of Hugo, go to https://github.com/gohugoio/hugo/releases and download the source code for the version of your choice. If you want to compile Hugo with all the latest changes (which might include bugs), clone the Hugo repository:

git clone https://github.com/gohugoio/hugo

{{% warning "Sometimes "Latest" = "Bugs""%}} Cloning the Hugo repository directly means taking the good with the bad. By using the bleeding-edge version of Hugo, you make your development susceptible to the latest features, as well as the latest bugs. Your feedback is appreciated. If you find a bug in the latest release, please create an issue on GitHub. {{% /warning %}}

Step 2: Compiling

Make the directory containing the source your working directory and then fetch Hugo's dependencies:

mkdir -p src/github.com/gohugoio
ln -sf $(pwd) src/github.com/gohugoio/hugo

# set the build path for Go
export GOPATH=$(pwd)

go get

This will fetch the absolute latest version of the dependencies. If Hugo fails to build, it may be the result of a dependency's author introducing a breaking change.

Once you have properly configured your directory, you can compile Hugo using the following command:

go build -o hugo main.go

Then place the hugo executable somewhere in your $PATH. You're now ready to start using Hugo.

Windows

The following aims to be a complete guide to installing Hugo on your Windows PC.

Assumptions

You will use C:\Hugo\Sites as the starting point for your new project.
You will use C:\Hugo\bin to store executable files.

Set up Your Directories

You'll need a place to store the Hugo executable, your content, and the generated Hugo website:

Open Windows Explorer.
Create a new folder: C:\Hugo, assuming you want Hugo on your C drive, although this can go anywhere
Create a subfolder in the Hugo folder: C:\Hugo\bin
Create another subfolder in Hugo: C:\Hugo\Sites

Technical Users

Download the latest zipped Hugo executable from Hugo Releases.
Extract all contents to your ..\Hugo\bin folder.
In PowerShell or your preferred CLI, add the hugo.exe executable to your PATH by navigating to C:\Hugo\bin (or the location of your hugo.exe file) and use the command set PATH=%PATH%;C:\Hugo\bin. If the hugo command does not work after a reboot, you may have to run the command prompt as administrator.

Less-technical Users

Go to the Hugo Releases page.
The latest release is announced on top. Scroll to the bottom of the release announcement to see the downloads. They're all ZIP files.
Find the Windows files near the bottom (they're in alphabetical order, so Windows is last) – download either the 32-bit or 64-bit file depending on whether you have 32-bit or 64-bit Windows. (If you don't know, see here.)
Move the ZIP file into your C:\Hugo\bin folder.
Double-click on the ZIP file and extract its contents. Be sure to extract the contents into the same C:\Hugo\bin folder – Windows will do this by default unless you tell it to extract somewhere else.
You should now have three new files: The hugo executable (hugo.exe), LICENSE, and README.md.

Now you need to add Hugo to your Windows PATH settings:

For Windows 10 Users:

Right click on the Start button.
Click on System.
Click on Advanced System Settings on the left.
Click on the Environment Variables... button on the bottom.
In the User variables section, find the row that starts with PATH (PATH will be all caps).
Double-click on PATH.
Click the New... button.
Type in the folder where hugo.exe was extracted, which is C:\Hugo\bin if you went by the instructions above. The PATH entry should be the folder where Hugo lives and not the binary. Press Enter when you're done typing.
Click OK at every window to exit.

{{% note "Path Editor in Windows 10"%}} The path editor in Windows 10 was added in the large November 2015 Update. You'll need to have that or a later update installed for the above steps to work. You can see what Windows 10 build you have by clicking on the Start button → Settings → System → About. See here for more.) {{% /note %}}

For Windows 7 and 8.x users:

Windows 7 and 8.1 do not include the easy path editor included in Windows 10, so non-technical users on those platforms are advised to install a free third-party path editor like Windows Environment Variables Editor or Path Editor.

Verify the Executable

Run a few commands to verify that the executable is ready to run, and then build a sample site to get started.

1. Open a Command Prompt

At the prompt, type hugo help and press the Enter key. You should see output that starts with:

hugo is the main command, used to build your Hugo site.

Hugo is a Fast and Flexible Static Site Generator
built with love by spf13 and friends in Go.

Complete documentation is available at https://gohugo.io/.

If you do, then the installation is complete. If you don't, double-check the path that you placed the hugo.exe file in and that you typed that path correctly when you added it to your PATH variable. If you're still not getting the output, search the Hugo discussion forum to see if others have already figured out our problem. If not, add a note---in the "Support" category---and be sure to include your command and the output.

At the prompt, change your directory to the Sites directory.

C:\Program Files> cd C:\Hugo\Sites
C:\Hugo\Sites>

2. Run the Command

Run the command to generate a new site. I'm using example.com as the name of the site.

C:\Hugo\Sites> hugo new site example.com

You should now have a directory at C:\Hugo\Sites\example.com. Change into that directory and list the contents. You should get output similar to the following:

C:\Hugo\Sites> cd example.com
C:\Hugo\Sites\example.com> dir
Directory of C:\hugo\sites\example.com

04/13/2015  10:44 PM    <DIR>          .
04/13/2015  10:44 PM    <DIR>          ..
04/13/2015  10:44 PM    <DIR>          archetypes
04/13/2015  10:44 PM                83 config.toml
04/13/2015  10:44 PM    <DIR>          content
04/13/2015  10:44 PM    <DIR>          data
04/13/2015  10:44 PM    <DIR>          layouts
04/13/2015  10:44 PM    <DIR>          static
               1 File(s)             83 bytes
               7 Dir(s)   6,273,331,200 bytes free

Troubleshoot Windows Installation

@dhersam has created a nice video on common issues:

Linux

Snap Package

In any of the Linux distributions that support snaps, you may install install the "extended" Sass/SCSS version with this command:

snap install hugo --channel=extended

To install the non-extended version without Sass/SCSS support:

snap install hugo

To switch between the two, use either snap refresh hugo --channel=extended or snap refresh hugo --channel=stable.

{{% note %}} Hugo installed via Snap can write only inside the user’s $HOME directory---and gvfs-mounted directories owned by the user---because of Snaps’ confinement and security model. More information is also available in this related GitHub issue. {{% /note %}}

Debian and Ubuntu

@anthonyfok and friends in the Debian Go Packaging Team maintains an official hugo Debian package which is shared with Ubuntu and is installable via apt-get:

sudo apt-get install hugo

This installs the "extended" Sass/SCSS version.

Arch Linux

You can also install Hugo from the Arch Linux community repository. Applies also to derivatives such as Manjaro.

sudo pacman -Syu hugo

Fedora, Red Hat and CentOS

Fedora maintains an official package for Hugo which may be installed with:

sudo dnf install hugo

For the latest version, the Hugo package maintained by @daftaupe at Fedora Copr is recommended:

https://copr.fedorainfracloud.org/coprs/daftaupe/hugo/

Solus

Solus includes Hugo in its package repository, it may be installed with:

sudo eopkg install hugo

OpenBSD

OpenBSD provides a package for Hugo via pkg_add:

doas pkg_add hugo

Upgrade Hugo

Upgrading Hugo is as easy as downloading and replacing the executable you’ve placed in your PATH or run brew upgrade hugo if using Homebrew.

Install Pygments (Optional)

The Hugo executable has one optional external dependency for source code highlighting (Pygments).

If you want to have source code highlighting using the highlight shortcode, you need to install the Python-based Pygments program. The procedure is outlined on the Pygments homepage.

Next Steps

Now that you've installed Hugo, read the Quick Start guide and explore the rest of the documentation. If you have questions, ask the Hugo community directly by visiting the Hugo Discussion Forum.

22 KiB Raw Blame History Unescape Escape

Quick Install

Binary (Cross-platform)

Homebrew (macOS)

Linuxbrew (Linux)

Chocolatey (Windows)

Scoop (Windows)

Source

Prerequisite Tools

Fetch from GitHub

macOS

Assumptions

Pick Your Method

Pros and Cons

Install Hugo with Brew

Step 1: Install brew if you haven't already

Step 2: Run the brew Command to Install hugo

Install Hugo from Tarball

Step 1: Decide on the location

Step 2: Download the Tarball

Step 3: Confirm your download

Step 4: Install Into Your bin Directory

Build from Source on Mac

Step 1: Get the Source

Step 2: Compiling

Windows

Assumptions

Set up Your Directories

Technical Users

Less-technical Users

For Windows 10 Users:

For Windows 7 and 8.x users:

Verify the Executable

1. Open a Command Prompt

2. Run the Command

Troubleshoot Windows Installation

Linux

Snap Package

Debian and Ubuntu

Arch Linux

Fedora, Red Hat and CentOS

Solus

OpenBSD

Upgrade Hugo

Install Pygments (Optional)

Next Steps

22 KiB

Raw Blame History

Step 1: Install `brew` if you haven't already

Step 2: Run the `brew` Command to Install `hugo`

Step 4: Install Into Your `bin` Directory