hugo/docs/content/overview/installing.md

---
aliases:
- /doc/installing/
date: 2013-07-01
menu:
  main:
    parent: getting started
next: /overview/usage
prev: /overview/quickstart
title: Installing Hugo
weight: 20
---

Hugo is written in Go with support for multiple platforms.

The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
We currently build for <i class="fa fa-windows"></i> Windows, <i class="fa fa-linux"></i> Linux, FreeBSD and <i class="fa fa-apple"></i> OS&nbsp;X for x64
and i386 architectures.

## Installing Hugo (binary)

Installation is very easy. Simply download the appropriate version for your
platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
Once downloaded it 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.

On OS&nbsp;X, if you have [Homebrew](http://brew.sh), installation is even
easier: just run `brew install hugo`.

### Installing 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](/extras/highlighting),
you need to install the Python-based Pygments program. The procedure is outlined on the [Pygments home page](http://pygments.org).

## Upgrading Hugo

Upgrading Hugo is as easy as downloading and replacing the executable you’ve
placed in your `PATH`.


## Installing from source

### Dependencies

* Git
* Go 1.1+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090))
* Mercurial
* Bazaar

### Get directly from GitHub

    $ export GOPATH=$HOME/go
    $ go get -v github.com/spf13/hugo

`go get` will then fetch Hugo and all its dependent libraries to your
`$GOPATH/src` directory, and compile everything into the final `hugo`
(or `hugo.exe`) executable, which you will find sitting in the
`$GOPATH/bin/hugo` directory, all ready to go!

## Contributing

Please see the [contributing guide](/doc/contributing).
-												sanity: move from json to yaml

											
										
										
											2013-07-06 23:36:30 +00:00
+								---
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								aliases:
 								- /doc/installing/
 								date: 2013-07-01
-												Implementing new menu system in the docs site

											
										
										
											2014-04-23 07:00:11 +00:00
+								menu:
 								  main:
-												Converting front matter to YAML

											
										
										
											2014-05-29 22:42:05 +00:00
+								    parent: getting started
 								next: /overview/usage
 								prev: /overview/quickstart
 								title: Installing Hugo
 								weight: 20
-												YAML support similar to jekyll (start and end with '---')

											
										
										
											2013-07-08 21:57:01 +00:00
+								---
-												sanity: move from json to yaml

											
										
										
											2013-07-06 23:36:30 +00:00
-												[Docs] More random revision and copyediting

General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.

											
										
										
											2015-01-14 03:48:44 +00:00
+								Hugo is written in Go with support for multiple platforms.
-												adding hugo

											
										
										
											2013-07-04 15:32:55 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
-												[Docs] More random revision and copyediting

General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.

											
										
										
											2015-01-14 03:48:44 +00:00
+								We currently build for <i class="fa fa-windows"></i> Windows, <i class="fa fa-linux"></i> Linux, FreeBSD and <i class="fa fa-apple"></i> OS&nbsp;X for x64
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								and i386 architectures.
-												adding hugo

											
										
										
											2013-07-04 15:32:55 +00:00
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
+								## Installing Hugo (binary)
-												better install instructions and fixing usage typo

											
										
										
											2013-07-05 04:35:11 +00:00
+								Installation is very easy. Simply download the appropriate version for your
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
+								Once downloaded it can be run from anywhere. You don't need to install
-												better install instructions and fixing usage typo

											
										
										
											2013-07-05 04:35:11 +00:00
+								it into a global location. This works well for shared hosts and other systems
 								where you don't have a privileged account.
-												adding hugo

											
										
										
											2013-07-04 15:32:55 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								Ideally, you should install it somewhere in your `PATH` for easy use.
 								`/usr/local/bin` is the most probable location.
-												adding hugo

											
										
										
											2013-07-04 15:32:55 +00:00
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								On OS&nbsp;X, if you have [Homebrew](http://brew.sh), installation is even
 								easier: just run `brew install hugo`.
-												instructions for Homebrew installation

updated installation page of documentation, and changed "Download" button on index.html to scroll to bottom where multiple installation options are featured

getting the scrolldown to work required removing the fixed positioning on #action and on the footer

											
										
										
											2014-09-22 23:58:30 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								### Installing Pygments (optional)
-												Misc doc fixes

  * Pygments links and requirements for installation.
  * Fix to link to additional template functions in release notes for
v0.10

											
										
										
											2014-04-08 15:15:56 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								The Hugo executable has one *optional* external dependency for source code highlighting (Pygments).
-												Misc doc fixes

  * Pygments links and requirements for installation.
  * Fix to link to additional template functions in release notes for
v0.10

											
										
										
											2014-04-08 15:15:56 +00:00
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting),
 								you need to install the Python-based Pygments program. The procedure is outlined on the [Pygments home page](http://pygments.org).
-												adding better install directions

											
										
										
											2013-07-04 17:03:16 +00:00
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
+								## Upgrading Hugo
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								Upgrading Hugo is as easy as downloading and replacing the executable you’ve
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								placed in your `PATH`.
-												Updating / Rewriting / Adding all of the documentation in preparation for the next release

											
										
										
											2014-05-27 22:32:57 +00:00
-												adding better install directions

											
										
										
											2013-07-04 17:03:16 +00:00
+								## Installing from source
-												Adding better source build instructions

											
										
										
											2013-07-19 05:27:21 +00:00
+								### Dependencies
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
+								* Git
-												[Docs] Go 1.4+ required for building on Windows

See Issue #688 for more information.

											
										
										
											2014-12-26 20:00:14 +00:00
+								* Go 1.1+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090))
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
+								* Mercurial
 								* Bazaar
-												adding better install directions

											
										
										
											2013-07-04 17:03:16 +00:00
-												[Docs] More random revision and copyediting

General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.

											
										
										
											2015-01-14 03:48:44 +00:00
+								### Get directly from GitHub
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
-												[Docs] More random revision and copyediting

General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.

											
										
										
											2015-01-14 03:48:44 +00:00
+								    $ export GOPATH=$HOME/go
-												Some more random copyediting of Hugo docs

 - Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.

											
										
										
											2015-01-09 18:51:15 +00:00
+								    $ go get -v github.com/spf13/hugo
-												adding better install directions

											
										
										
											2013-07-04 17:03:16 +00:00
-												[Docs] More random revision and copyediting

General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.

											
										
										
											2015-01-14 03:48:44 +00:00
+								`go get` will then fetch Hugo and all its dependent libraries to your
 								`$GOPATH/src` directory, and compile everything into the final `hugo`
 								(or `hugo.exe`) executable, which you will find sitting in the
 								`$GOPATH/bin/hugo` directory, all ready to go!
-												Improving installation instructions

											
										
										
											2013-07-24 15:43:23 +00:00
 								## Contributing
-												Minor proofreading corrections to Hugo docs

											
										
										
											2014-08-31 11:08:36 +00:00
+								Please see the [contributing guide](/doc/contributing).