hugo/docs/content/overview/installing.md

86 lines
3.1 KiB
Markdown
Raw Normal View History

2013-07-06 19:36:30 -04:00
---
2014-05-29 18:42:05 -04:00
aliases:
- /doc/installing/
lastmod: 2016-01-04
2014-05-29 18:42:05 -04:00
date: 2013-07-01
menu:
main:
2014-05-29 18:42:05 -04:00
parent: getting started
next: /overview/usage
prev: /overview/quickstart
title: Installing Hugo
weight: 20
---
2013-07-06 19:36:30 -04:00
Hugo is written in [Go][] with support for multiple platforms.
2013-07-04 11:32:55 -04:00
The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
We currently provide pre-built binaries for
<i class="fa fa-windows"></i>&nbsp;Windows,
<i class="fa fa-linux"></i>&nbsp;Linux,
<i class="fa freebsd-19px"></i>&nbsp;FreeBSD
and <i class="fa fa-apple"></i>&nbsp;OS&nbsp;X (Darwin)
for x64, i386 and ARM architectures.
2013-07-04 11:32:55 -04:00
Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including DragonFly BSD, OpenBSD, Plan&nbsp;9 and Solaris. See http://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures.
2013-07-24 11:43:23 -04:00
## Installing Hugo (binary)
Installation is very easy. Simply download the appropriate version for your
platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
2013-07-24 11:43:23 -04:00
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.
2013-07-04 11:32:55 -04:00
Ideally, you should install it somewhere in your `PATH` for easy use.
`/usr/local/bin` is the most probable location.
2013-07-04 11:32:55 -04:00
On OS&nbsp;X, if you have [Homebrew](http://brew.sh/), installation is even
easier: just run `brew update && brew install hugo`.
For a more detailed explanation follow the corresponding installation guides:
- [Installation on OS X]({{< relref "tutorials/installing-on-mac.md" >}})
- [Installation on Windows]({{< relref "tutorials/installing-on-windows.md" >}})
### 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/).
2013-07-04 13:03:16 -04:00
## Upgrading Hugo
Upgrading Hugo is as easy as downloading and replacing the executable youve
placed in your `PATH`.
2013-07-04 13:03:16 -04:00
## Installing from source
### Prerequisite tools for downloading and building source code
* [Git](http://git-scm.com/)
* [Mercurial](http://mercurial.selenic.com/)
* [Go][] 1.3+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090))
2013-07-04 13:03:16 -04:00
### Get directly from GitHub
2013-07-24 11:43:23 -04:00
$ export GOPATH=$HOME/go
$ go get -v github.com/spf13/hugo
2013-07-04 13:03:16 -04: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/` directory, all ready to go!
You may run `go get` with the `-u` option to update Hugo's dependencies:
$ go get -u -v github.com/spf13/hugo
2013-07-24 11:43:23 -04:00
## Contributing
Please see the [contributing guide](/doc/contributing/).
[Go]: http://golang.org/