hugo/docs/content/en/commands/hugo_server.md

90 lines
4.4 KiB
Markdown
Raw Normal View History

---
2018-11-05 13:18:45 +00:00
date: 2018-11-05
title: "hugo server"
slug: hugo_server
url: /commands/hugo_server/
---
## hugo server
A high performance webserver
### Synopsis
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.
```
hugo server [flags]
```
### Options
```
Squashed 'docs/' changes from e5e98b950..084804447 084804447 Update shortcode-templates.md c01b02434 Correct misspelling of 'default' 52a831cca Added missing parenthesis 59e8e660a Fix spelling typos 29ad53c9c Yes, HTML is a valid content format c6b193c6f Update shortcode-templates.md 1f2846e6d Fix typo in output format README 5882f7a4c Fix typo a90a00bb0 Update multilingual.md 62bf0f184 Documentation for Open Graph & Twitter Cards f4d624da3 Document "images", "videos", etc. in front-matter 6a85b5df1 Document anchorize and Resources.Content 04c8a5b0e Fix minor typo in 0.49.2 release note dbe77e948 Release 0.49.2 ea6c9658e Merge branch 'temp492' 85c45b725 Merge branch 'release-0.49.2' 7ad1fba29 releaser: Prepare repository for 0.50-DEV b25bcc3f2 releaser: Add release notes to /docs for release of 0.49.2 78b751b91 releaser: Bump versions for release of 0.49.2 e3f09762c Release 0.49.1 bd5b94558 Merge branch 'temp491' 0007e0661 Merge branch 'release-0.49.1' 74d2f3a6f releaser: Prepare repository for 0.50-DEV bbee7e9d3 releaser: Add release notes to /docs for release of 0.49.1 ae40c89c7 releaser: Bump versions for release of 0.49.1 11079fb48 Add draft statement to FAQ 069b9472f Addin Hokus CMS to frontends list. 6e8850670 Add MediaType docs f3ca6209a Add `languageName` to configuration fd1cde5ea tpl: Add a delimiter parameter to lang.NumFmt c620ff78a Update doc to use proper variable 7317c339a add tools->hugo-elasticsearch description to docs d758ef94a hugolib: Introduce Page.NextPage and Page.PrevPage 9c93ac031 Update installing.md 7c0b5b7f5 Use ISO 639-1 code for examples 9a9e40ba8 Fix spelling 9a6216c18 Hugo 0.49 55aa91185 Merge branch 'temp49' e0a36421e releaser: Prepare repository for 0.50-DEV c07b3b385 releaser: Add release notes to /docs for release of 0.49 c1175a12a releaser: Bump versions for release of 0.49 2966f6254 docs: Document directory based archetypes 73dcd02ed Add showcase archetype folder 0a55ad11b docs: Regenerate CLI docs e09866c2d docs: Document group ef986358a Merge commit '807c551922707fc5ae0eb26e8f01638c0c63fdb3' 681f14fc9 tpl/collections: Allow first function to return an empty slice f6dcc93bc docs: Add docs for append aae528ca3 Merge commit '13e64d72763bf8d6d92d4cdfc15ed45ee9debfab' 02b62294c tpl/strings: Add strings.FirstUpper bf3e61ba3 hugolib: Do not FirstUpper taxonomy titles git-subtree-dir: docs git-subtree-split: 084804447402ab99b51bf49f0da809bee8c16339
2018-10-29 08:19:20 +00:00
--appendPort append port to baseURL (default true)
-b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/
--bind string interface to which the server will bind (default "127.0.0.1")
-D, --buildDrafts include content marked as draft
-E, --buildExpired include expired content
-F, --buildFuture include content with publishdate in the future
--cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/
--cleanDestinationDir remove files from destination not found in static directories
-c, --contentDir string filesystem path to content directory
-d, --destination string filesystem path to write files to
2018-10-29 08:29:27 +00:00
--disableBrowserError do not show build errors in the browser
Squashed 'docs/' changes from e5e98b950..084804447 084804447 Update shortcode-templates.md c01b02434 Correct misspelling of 'default' 52a831cca Added missing parenthesis 59e8e660a Fix spelling typos 29ad53c9c Yes, HTML is a valid content format c6b193c6f Update shortcode-templates.md 1f2846e6d Fix typo in output format README 5882f7a4c Fix typo a90a00bb0 Update multilingual.md 62bf0f184 Documentation for Open Graph & Twitter Cards f4d624da3 Document "images", "videos", etc. in front-matter 6a85b5df1 Document anchorize and Resources.Content 04c8a5b0e Fix minor typo in 0.49.2 release note dbe77e948 Release 0.49.2 ea6c9658e Merge branch 'temp492' 85c45b725 Merge branch 'release-0.49.2' 7ad1fba29 releaser: Prepare repository for 0.50-DEV b25bcc3f2 releaser: Add release notes to /docs for release of 0.49.2 78b751b91 releaser: Bump versions for release of 0.49.2 e3f09762c Release 0.49.1 bd5b94558 Merge branch 'temp491' 0007e0661 Merge branch 'release-0.49.1' 74d2f3a6f releaser: Prepare repository for 0.50-DEV bbee7e9d3 releaser: Add release notes to /docs for release of 0.49.1 ae40c89c7 releaser: Bump versions for release of 0.49.1 11079fb48 Add draft statement to FAQ 069b9472f Addin Hokus CMS to frontends list. 6e8850670 Add MediaType docs f3ca6209a Add `languageName` to configuration fd1cde5ea tpl: Add a delimiter parameter to lang.NumFmt c620ff78a Update doc to use proper variable 7317c339a add tools->hugo-elasticsearch description to docs d758ef94a hugolib: Introduce Page.NextPage and Page.PrevPage 9c93ac031 Update installing.md 7c0b5b7f5 Use ISO 639-1 code for examples 9a9e40ba8 Fix spelling 9a6216c18 Hugo 0.49 55aa91185 Merge branch 'temp49' e0a36421e releaser: Prepare repository for 0.50-DEV c07b3b385 releaser: Add release notes to /docs for release of 0.49 c1175a12a releaser: Bump versions for release of 0.49 2966f6254 docs: Document directory based archetypes 73dcd02ed Add showcase archetype folder 0a55ad11b docs: Regenerate CLI docs e09866c2d docs: Document group ef986358a Merge commit '807c551922707fc5ae0eb26e8f01638c0c63fdb3' 681f14fc9 tpl/collections: Allow first function to return an empty slice f6dcc93bc docs: Add docs for append aae528ca3 Merge commit '13e64d72763bf8d6d92d4cdfc15ed45ee9debfab' 02b62294c tpl/strings: Add strings.FirstUpper bf3e61ba3 hugolib: Do not FirstUpper taxonomy titles git-subtree-dir: docs git-subtree-split: 084804447402ab99b51bf49f0da809bee8c16339
2018-10-29 08:19:20 +00:00
--disableFastRender enables full re-renders on changes
--disableKinds strings disable different kind of pages (home, RSS etc.)
--disableLiveReload watch without enabling live browser reload on rebuild
--enableGitInfo add Git revision, date and author info to the pages
--forceSyncStatic copy all files when static is changed.
--gc enable to run some cleanup tasks (remove unused cache files) after the build
-h, --help help for server
--i18n-warnings print missing translations
--ignoreCache ignores the cache directory
-l, --layoutDir string filesystem path to layout directory
--liveReloadPort int port for live reloading (i.e. 443 in HTTPS proxy situations) (default -1)
--meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms")
--memstats string log memory usage to this file
2018-11-05 13:18:45 +00:00
--minify minify any supported output format (HTML, XML etc.)
Squashed 'docs/' changes from e5e98b950..084804447 084804447 Update shortcode-templates.md c01b02434 Correct misspelling of 'default' 52a831cca Added missing parenthesis 59e8e660a Fix spelling typos 29ad53c9c Yes, HTML is a valid content format c6b193c6f Update shortcode-templates.md 1f2846e6d Fix typo in output format README 5882f7a4c Fix typo a90a00bb0 Update multilingual.md 62bf0f184 Documentation for Open Graph & Twitter Cards f4d624da3 Document "images", "videos", etc. in front-matter 6a85b5df1 Document anchorize and Resources.Content 04c8a5b0e Fix minor typo in 0.49.2 release note dbe77e948 Release 0.49.2 ea6c9658e Merge branch 'temp492' 85c45b725 Merge branch 'release-0.49.2' 7ad1fba29 releaser: Prepare repository for 0.50-DEV b25bcc3f2 releaser: Add release notes to /docs for release of 0.49.2 78b751b91 releaser: Bump versions for release of 0.49.2 e3f09762c Release 0.49.1 bd5b94558 Merge branch 'temp491' 0007e0661 Merge branch 'release-0.49.1' 74d2f3a6f releaser: Prepare repository for 0.50-DEV bbee7e9d3 releaser: Add release notes to /docs for release of 0.49.1 ae40c89c7 releaser: Bump versions for release of 0.49.1 11079fb48 Add draft statement to FAQ 069b9472f Addin Hokus CMS to frontends list. 6e8850670 Add MediaType docs f3ca6209a Add `languageName` to configuration fd1cde5ea tpl: Add a delimiter parameter to lang.NumFmt c620ff78a Update doc to use proper variable 7317c339a add tools->hugo-elasticsearch description to docs d758ef94a hugolib: Introduce Page.NextPage and Page.PrevPage 9c93ac031 Update installing.md 7c0b5b7f5 Use ISO 639-1 code for examples 9a9e40ba8 Fix spelling 9a6216c18 Hugo 0.49 55aa91185 Merge branch 'temp49' e0a36421e releaser: Prepare repository for 0.50-DEV c07b3b385 releaser: Add release notes to /docs for release of 0.49 c1175a12a releaser: Bump versions for release of 0.49 2966f6254 docs: Document directory based archetypes 73dcd02ed Add showcase archetype folder 0a55ad11b docs: Regenerate CLI docs e09866c2d docs: Document group ef986358a Merge commit '807c551922707fc5ae0eb26e8f01638c0c63fdb3' 681f14fc9 tpl/collections: Allow first function to return an empty slice f6dcc93bc docs: Add docs for append aae528ca3 Merge commit '13e64d72763bf8d6d92d4cdfc15ed45ee9debfab' 02b62294c tpl/strings: Add strings.FirstUpper bf3e61ba3 hugolib: Do not FirstUpper taxonomy titles git-subtree-dir: docs git-subtree-split: 084804447402ab99b51bf49f0da809bee8c16339
2018-10-29 08:19:20 +00:00
--navigateToChanged navigate to changed content file on live browser reload
--noChmod don't sync permission mode of files
--noHTTPCache prevent HTTP caching
--noTimes don't sync modification time of files
-p, --port int port on which the server will listen (default 1313)
--renderToDisk render to Destination path (default is render to memory & serve from there)
-s, --source string filesystem path to read files relative from
--stepAnalysis display memory and timing of different steps of the program
--templateMetrics display metrics about template executions
--templateMetricsHints calculate some improvement hints when combined with --templateMetrics
-t, --theme string theme to use (located in /themes/THEMENAME/)
--themesDir string filesystem path to themes directory
-w, --watch watch filesystem for changes and recreate as needed (default true)
```
### Options inherited from parent commands
```
--config string config file (default is path/config.yaml|json|toml)
--debug debug output
--log enable Logging
--logFile string log File path (if set, logging enabled automatically)
--quiet build in quiet mode
-v, --verbose verbose output
--verboseLog verbose logging
```
### SEE ALSO
* [hugo](/commands/hugo/) - hugo builds your site
2018-11-05 13:18:45 +00:00
###### Auto generated by spf13/cobra on 5-Nov-2018