DragonFly On-Line Manual Pages

HUGO-SERVER(1)                    Hugo Manual                   HUGO-SERVER(1)

NAME
       hugo-server - A high performance webserver

SYNOPSIS
       hugo server [flags]

DESCRIPTION
       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.

OPTIONS
       --appendPort[=true]      append port to baseURL

       -b, --baseURL=""    hostname (and path) to the root, e.g.
       https://spf13.com/

       --bind="127.0.0.1"  interface to which the server will bind

       -D, --buildDrafts[=false]     include content marked as draft

       -E, --buildExpired[=false]    include expired content

       -F, --buildFuture[=false]     include content with publishdate in the
       future

       --cacheDir=""  filesystem path to cache directory. Defaults:
       $TMPDIR/hugo_cache/

       --cleanDestinationDir[=false]      remove files from destination not
       found in static directories

       --clock=""     set the clock used by Hugo, e.g. --clock
       2021-11-06T22:30:00.00+09:00

       -c, --contentDir=""      filesystem path to content directory

       -d, --destination=""     filesystem path to write files to

       --disableBrowserError[=false]      do not show build errors in the
       browser

       --disableFastRender[=false]   enables full re-renders on changes

       --disableKinds=[]   disable different kind of pages (home, RSS etc.)

       --disableLiveReload[=false]   watch without enabling live browser
       reload on rebuild

       --enableGitInfo[=false]  add Git revision, date, author, and CODEOWNERS
       info to the pages

       -e, --environment=""     build environment

       --forceSyncStatic[=false]     copy all files when static is changed.

       --gc[=false]   enable to run some cleanup tasks (remove unused cache
       files) after the build

       -h, --help[=false]  help for server

       --ignoreCache[=false]    ignores the cache directory

       --ignoreVendorPaths=""   ignores any _vendor for module paths matching
       the given Glob pattern

       -l, --layoutDir=""  filesystem path to layout directory

       --liveReloadPort=-1      port for live reloading (i.e. 443 in HTTPS
       proxy situations)

       --meminterval="100ms"    interval to poll memory usage (requires
       --memstats), valid time units are "ns", "us" (or "<micro>s"), "ms",
       "s", "m", "h".

       --memstats=""  log memory usage to this file

       --minify[=false]    minify any supported output format (HTML, XML etc.)

       --navigateToChanged[=false]   navigate to changed content file on live
       browser reload

       --noBuildLock[=false]    don't create .hugo_build.lock file

       --noChmod[=false]   don't sync permission mode of files

       --noHTTPCache[=false]    prevent HTTP caching

       --noTimes[=false]   don't sync modification time of files

       --panicOnWarning[=false]      panic on first WARNING log

       --poll=""      set this to a poll interval, e.g --poll 700ms, to use a
       poll based approach to watch for file system changes

       -p, --port=1313     port on which the server will listen

       --printI18nWarnings[=false]   print missing translations

       --printMemoryUsage[=false]    print memory usage to screen at intervals

       --printPathWarnings[=false]   print warnings on duplicate target paths
       etc.

       --printUnusedTemplates[=false]     print warnings on unused templates.

       --renderStaticToDisk[=false]  serve static files from disk and dynamic
       files from memory

       --renderToDisk[=false]   serve all files from disk (default is from
       memory)

       -s, --source=""     filesystem path to read files relative from

       --templateMetrics[=false]     display metrics about template executions

       --templateMetricsHints[=false]     calculate some improvement hints
       when combined with --templateMetrics

       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)

       --themesDir=""      filesystem path to themes directory

       --trace=""     write trace to file (not useful in general)

       -w, --watch[=true]  watch filesystem for changes and recreate as needed

OPTIONS INHERITED FROM PARENT COMMANDS
       --config=""    config file (default is hugo.yaml|json|toml)

       --configDir="config"     config dir

       --debug[=false]     debug output

       --log[=false]  enable Logging

       --logFile=""   log File path (if set, logging enabled automatically)

       --quiet[=false]     build in quiet mode

       -v, --verbose[=false]    verbose output

       --verboseLog[=false]     verbose logging

SEE ALSO
       hugo(1)

Hugo 0.111.3                       Sep 2023                     HUGO-SERVER(1)