2015-05-13 09:31:30 -04:00
|
|
|
---
|
2015-12-16 11:26:06 -05:00
|
|
|
date: 2015-12-16T09:24:56-07:00
|
2015-05-13 09:31:30 -04:00
|
|
|
title: "hugo server"
|
|
|
|
slug: hugo_server
|
|
|
|
url: /commands/hugo_server/
|
|
|
|
---
|
|
|
|
## hugo server
|
|
|
|
|
2015-11-25 17:11:16 -05:00
|
|
|
A high performance webserver
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
### Synopsis
|
|
|
|
|
|
|
|
|
2015-11-25 17:11:16 -05:00
|
|
|
Hugo provides its own webserver which builds and serves the site.
|
|
|
|
While hugo server is high performance, it is a webserver with limited options.
|
|
|
|
Many run it in production, but the standard behavior is for people to use it
|
|
|
|
in development and use a more full featured server such as Nginx or Caddy.
|
|
|
|
|
|
|
|
'hugo server' will avoid writing the rendered and served content to disk,
|
|
|
|
preferring to store it in memory.
|
|
|
|
|
|
|
|
By default hugo will also watch your files for any changes you make and
|
|
|
|
automatically rebuild the site. It will then live reload any open browser pages
|
|
|
|
and push the latest content to them. As most Hugo sites are built in a fraction
|
|
|
|
of a second, you will be able to save and see your changes nearly instantly.
|
2015-05-13 09:31:30 -04:00
|
|
|
|
|
|
|
```
|
|
|
|
hugo server
|
|
|
|
```
|
|
|
|
|
|
|
|
### Options
|
|
|
|
|
|
|
|
```
|
2015-08-04 05:15:12 -04:00
|
|
|
--appendPort[=true]: append port to baseurl
|
2015-09-09 01:29:04 -04:00
|
|
|
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
|
2015-12-11 11:50:36 -05:00
|
|
|
--bind="127.0.0.1": interface to which the server will bind
|
2015-08-04 05:15:12 -04:00
|
|
|
-D, --buildDrafts[=false]: include content marked as draft
|
|
|
|
-F, --buildFuture[=false]: include content with publishdate in the future
|
2015-05-13 09:31:30 -04:00
|
|
|
--cacheDir="": filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
|
2015-11-25 17:11:16 -05:00
|
|
|
--canonifyURLs[=false]: if true, all relative URLs will be canonicalized using baseURL
|
2015-05-13 09:31:30 -04:00
|
|
|
--config="": config file (default is path/config.yaml|json|toml)
|
|
|
|
-d, --destination="": filesystem path to write files to
|
2015-12-11 11:50:36 -05:00
|
|
|
--disableLiveReload[=false]: watch without enabling live browser reload on rebuild
|
2015-08-04 05:15:12 -04:00
|
|
|
--disableRSS[=false]: Do not build RSS files
|
|
|
|
--disableSitemap[=false]: Do not build Sitemap file
|
2015-05-13 09:31:30 -04:00
|
|
|
--editor="": edit new content with this editor, if provided
|
2015-08-04 05:15:12 -04:00
|
|
|
--ignoreCache[=false]: Ignores the cache directory for reading but still writes to it
|
2015-12-11 11:50:36 -05:00
|
|
|
--meminterval=100: interval to poll memory usage (requires --memstats)
|
|
|
|
--memstats="": log memory usage to this file
|
|
|
|
--noTimes[=false]: Don't sync modification time of files
|
2015-08-04 05:15:12 -04:00
|
|
|
--pluralizeListTitles[=true]: Pluralize titles in lists using inflect
|
2015-12-11 11:50:36 -05:00
|
|
|
-p, --port=1313: port on which the server will listen
|
2015-08-04 05:15:12 -04:00
|
|
|
--preserveTaxonomyNames[=false]: Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")
|
2015-12-11 11:50:36 -05:00
|
|
|
--renderToDisk[=false]: render to Destination path (default is render to memory & serve from there)
|
2015-05-13 09:31:30 -04:00
|
|
|
-s, --source="": filesystem path to read files relative from
|
2015-08-04 05:15:12 -04:00
|
|
|
--stepAnalysis[=false]: display memory and timing of different steps of the program
|
2015-05-13 09:31:30 -04:00
|
|
|
-t, --theme="": theme to use (located in /themes/THEMENAME/)
|
2015-09-09 01:29:04 -04:00
|
|
|
--uglyURLs[=false]: if true, use /filename.html instead of /filename/
|
2015-12-11 11:50:36 -05:00
|
|
|
-w, --watch[=true]: watch filesystem for changes and recreate as needed
|
|
|
|
```
|
|
|
|
|
|
|
|
### Options inherited from parent commands
|
|
|
|
|
|
|
|
```
|
|
|
|
--log[=false]: Enable Logging
|
|
|
|
--logFile="": Log File path (if set, logging enabled automatically)
|
2015-08-04 05:15:12 -04:00
|
|
|
-v, --verbose[=false]: verbose output
|
|
|
|
--verboseLog[=false]: verbose logging
|
2015-05-13 09:31:30 -04:00
|
|
|
```
|
|
|
|
|
|
|
|
### SEE ALSO
|
2015-05-21 07:30:01 -04:00
|
|
|
* [hugo](/commands/hugo/) - hugo builds your site
|
2015-05-13 09:31:30 -04:00
|
|
|
|
2015-12-16 11:26:06 -05:00
|
|
|
###### Auto generated by spf13/cobra on 16-Dec-2015
|