hugo-server(1)

1HUGO-SERVER(1)                    Hugo Manual                   HUGO-SERVER(1)
2
3
4

NAME

6       hugo-server - A high performance webserver
7
8
9

SYNOPSIS

11       hugo server [flags]
12
13
14

DESCRIPTION

16       Hugo  provides  its  own  webserver  which  builds and serves the site.
17       While hugo server is high performance, it is a webserver  with  limited
18       options.   Many  run it in production, but the standard behavior is for
19       people to use it in development and use a  more  full  featured  server
20       such as Nginx or Caddy.
21
22
23       'hugo  server'  will  avoid  writing the rendered and served content to
24       disk, preferring to store it in memory.
25
26
27       By default hugo will also watch your files for any changes you make and
28       automatically  rebuild  the  site.  It  will  then live reload any open
29       browser pages and push the latest content to them. As most  Hugo  sites
30       are  built  in a fraction of a second, you will be able to save and see
31       your changes nearly instantly.
32
33
34

OPTIONS

36       --appendPort[=true]      append port to baseURL
37
38
39       -b,  --baseURL=""       hostname  (and  path)   to   the   root,   e.g.
40       https://spf13.com/
41
42
43       --bind="127.0.0.1"      interface to which the server will bind
44
45
46       -D, --buildDrafts[=false]      include content marked as draft
47
48
49       -E, --buildExpired[=false]      include expired content
50
51
52       -F,  --buildFuture[=false]      include content with publishdate in the
53       future
54
55
56       --cacheDir=""      filesystem path to cache directory.  Defaults:  $TM‐
57       PDIR/hugo_cache/
58
59
60       --cleanDestinationDir[=false]       remove  files  from destination not
61       found in static directories
62
63
64       -c, --contentDir=""      filesystem path to content directory
65
66
67       -d, --destination=""      filesystem path to write files to
68
69
70       --disableBrowserError[=false]      do not  show  build  errors  in  the
71       browser
72
73
74       --disableFastRender[=false]      enables full re-renders on changes
75
76
77       --disableKinds=[]      disable different kind of pages (home, RSS etc.)
78
79
80       --disableLiveReload[=false]       watch  without  enabling live browser
81       reload on rebuild
82
83
84       --enableGitInfo[=false]      add Git revision, date, author, and  CODE‐
85       OWNERS info to the pages
86
87
88       --forceSyncStatic[=false]      copy all files when static is changed.
89
90
91       --gc[=false]      enable to run some cleanup tasks (remove unused cache
92       files) after the build
93
94
95       -h, --help[=false]      help for server
96
97
98       --ignoreCache[=false]      ignores the cache directory
99
100
101       -l, --layoutDir=""      filesystem path to layout directory
102
103
104       --liveReloadPort=-1      port for live reloading  (i.e.  443  in  HTTPS
105       proxy situations)
106
107
108       --meminterval="100ms"       interval  to  poll  memory  usage (requires
109       --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m",
110       "h".
111
112
113       --memstats=""      log memory usage to this file
114
115
116       --minify[=false]       minify  any  supported  output format (HTML, XML
117       etc.)
118
119
120       --navigateToChanged[=false]      navigate to changed  content  file  on
121       live browser reload
122
123
124       --noChmod[=false]      don't sync permission mode of files
125
126
127       --noHTTPCache[=false]      prevent HTTP caching
128
129
130       --noTimes[=false]      don't sync modification time of files
131
132
133       --panicOnWarning[=false]      panic on first WARNING log
134
135
136       --poll=""       set this to a poll interval, e.g --poll 700ms, to use a
137       poll based approach to watch for file system changes
138
139
140       -p, --port=1313      port on which the server will listen
141
142
143       --printI18nWarnings[=false]      print missing translations
144
145
146       --printMemoryUsage[=false]      print memory usage to screen at  inter‐
147       vals
148
149
150       --printPathWarnings[=false]       print  warnings  on  duplicate target
151       paths etc.
152
153
154       --printUnusedTemplates[=false]      print warnings on unused templates.
155
156
157       --renderStaticToDisk[=false]      serve static files from disk and  dy‐
158       namic files from memory
159
160
161       --renderToDisk[=false]       serve all files from disk (default is from
162       memory)
163
164
165       --templateMetrics[=false]      display metrics  about  template  execu‐
166       tions
167
168
169       --templateMetricsHints[=false]       calculate  some  improvement hints
170       when combined with --templateMetrics
171
172
173       -t, --theme=[]      themes to use (located in /themes/THEMENAME/)
174
175
176       --trace=""      write trace to file (not useful in general)
177
178
179       -w, --watch[=true]      watch filesystem for changes  and  recreate  as
180       needed
181
182
183

OPTIONS INHERITED FROM PARENT COMMANDS

185       --config=""      config file (default is path/config.yaml|json|toml)
186
187
188       --configDir="config"      config dir
189
190
191       --debug[=false]      debug output
192
193
194       -e, --environment=""      build environment
195
196
197       --ignoreVendorPaths=""      ignores any _vendor for module paths match‐
198       ing the given Glob pattern
199
200
201       --log[=false]      enable Logging
202
203
204       --logFile=""      log File path (if set, logging enabled automatically)
205
206
207       --quiet[=false]      build in quiet mode
208
209
210       -s, --source=""      filesystem path to read files relative from
211
212
213       --themesDir=""      filesystem path to themes directory
214
215
216       -v, --verbose[=false]      verbose output
217
218
219       --verboseLog[=false]      verbose logging
220
221
222

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

OPTIONS INHERITED FROM PARENT COMMANDS

SEE ALSO