1HUGO-SERVER(1) Hugo Manual HUGO-SERVER(1)
2
3
4
6 hugo-server - A high performance webserver
7
8
9
11 hugo server [flags]
12
13
14
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
36 --appendPort[=true] append port to baseURL
37
38
39 -b, --baseURL="" hostname (and path) to the root, e.g.
40 http://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 --renderToDisk[=false] render to Destination path (default is ren‐
158 der to memory & serve from there)
159
160
161 --templateMetrics[=false] display metrics about template execu‐
162 tions
163
164
165 --templateMetricsHints[=false] calculate some improvement hints
166 when combined with --templateMetrics
167
168
169 -t, --theme=[] themes to use (located in /themes/THEMENAME/)
170
171
172 --trace="" write trace to file (not useful in general)
173
174
175 -w, --watch[=true] watch filesystem for changes and recreate as
176 needed
177
178
179
181 --config="" config file (default is path/config.yaml|json|toml)
182
183
184 --configDir="config" config dir
185
186
187 --debug[=false] debug output
188
189
190 -e, --environment="" build environment
191
192
193 --ignoreVendorPaths="" ignores any _vendor for module paths match‐
194 ing the given Glob pattern
195
196
197 --log[=false] enable Logging
198
199
200 --logFile="" log File path (if set, logging enabled automatically)
201
202
203 --quiet[=false] build in quiet mode
204
205
206 -s, --source="" filesystem path to read files relative from
207
208
209 --themesDir="" filesystem path to themes directory
210
211
212 -v, --verbose[=false] verbose output
213
214
215 --verboseLog[=false] verbose logging
216
217
218
220 hugo(1)
221
222
223
224Hugo 0.93.3 May 2022 HUGO-SERVER(1)