Deployment Scenarios
Offline Usage
The theme is usable offline. No internet connection is required to load your page. This is achieved by storing all dependencies within the theme.
No calls to 3rd party servers, no calling home, no tracking. Privacy friendly.
Server Deployment
If your server deployment has no special requirements, you can skip this section and use the standard Hugo options.
For special requirements, the theme is capable of different scenarios, requiring the following mandatory settings in your hugo.toml
. All settings not mentioned in the examples below can be set to your liking.
Public Web Server from Root
baseURL = 'https://example.com/'
baseURL: https://example.com/
{
"baseURL": "https://example.com/"
}
Public Web Server from Subdirectory
baseURL = 'https://example.com/mysite/'
relativeURLs = false
baseURL: https://example.com/mysite/
relativeURLs: false
{
"baseURL": "https://example.com/mysite/",
"relativeURLs": false
}
If you are still using Hugo’s relref
shortcode (which you shouldn’t), you will need further configuration.
Warning
Don’t use a baseURL
with a subdirectory and relativeURLs=true
together. Hugo doesn’t apply the baseURL
correctly in this case. If you need both, generate your site twice with different settings into separate directories.
Private Web Server (LAN)
The same settings as with any of the public web server scenarios or
baseURL = '/'
relativeURLs = true
baseURL: /
relativeURLs: true
{
"baseURL": "/",
"relativeURLs": true
}
File System
Your generated site can be used headless without a HTTP server.
This can be achieved by using the file://
protocol in your browser’s address bar or by double click on a generated *.html
file in your file navigation tool.
Use the following settings
baseURL = '/'
relativeURLs = true
baseURL: /
relativeURLs: true
{
"baseURL": "/",
"relativeURLs": true
}
Note
Pages like sitemap.xml
and rss.xml
, and social media links will always use absolute URLs. They won’t work with relativeURLs=true
.