The Sitemap-URL header can be set on the root node to specify the URL path for Uriel to write the generated sitemap for the web site.
If the Sitemap-URL header is not set, then Uriel will not write a sitemap file.
If the Sitemap-URL header is set, then the Canonical-URL header must also be set on the root node.
The Sitemap-URL value is a URL path, starting with a slash, where Uriel will write the sitemap file.
For example, on this documentation site, the Sitemap-URL header is set on the root node to a value of /sitemap.xml, like this:
Sitemap-URL: /sitemap.xml
This causes Uriel to write a sitemap to the specified path, which you can see here: /sitemap.xml
If the path specified in the Sitemap-URL header ends with a .gz extension, then the sitemap will be compressed with gzip automatically when the file is written.
You can write a sitemap into a subdirectory. However, the subdirectory must already exist. Search engines also have additional rules about sitemap locations. Putting the sitemap at the root of your web site is usually the best choice.
The sitemap URL can be referenced in templates using the {{value:sitemap-url}} substitution parameter to reference the Sitemap-URL header.
You can also set the maximum number of entries that can be included in the sitemap using the Sitemap-Max-Entries header.
See the RSS, Sitemap, robots.txt page for additional details about how to generate a sitemap.
Tags: root-node, sitemap, sitemap-headers
This page was generated by Uriel with the following settings:
Page Details
| Resource | Path | Project File |
|---|---|---|
| Node | headers/sitemap-url | nodes/headers/sitemap-url |
| Template | default.html | templates/default.html |
| URL | /headers/sitemap-url/ | public/headers/sitemap-url/index.html |
Node Headers
| Header (Lowercase) | Value |
|---|---|
| tags | sitemap, sitemap-headers, root-node |
| title | Sitemap-URL |
| +-tags | * |
| breadcrumb-separator | » |
| canonical-url | https://documentation.uriel.foo |
| rss-description | Uriel Documentation |
| rss-image-height | 32 |
| rss-image-url | /favicon-32x32.png |
| rss-image-width | 32 |
| rss-max-entries | 50 |
| rss-title | Uriel Documentation |
| rss-url | /rss.xml |
| sitemap-max-entries | 10000 |
| sitemap-url | /sitemap.xml |
| tag-node | tag |
| template | default.html |
Node Timestamps
| Type | Value |
|---|---|
| Created | |
| Modified | 2026-06-07T22:59:03-04:00 |
Node Methods
| Method | Value |
|---|---|
| get_parent_node() | headers/index |
| get_path() | headers/sitemap-url |
| get_node_type() | file |
| get_url() | /headers/sitemap-url/ |
| get_canonical_url() | https://documentation.uriel.foo/headers/sitemap-url/ |
| get_name() | sitemap-url |
| get_display_name() | Sitemap Url |
| get_title() | Sitemap-URL |
| get_escaped_title() | Sitemap-URL |
| get_link() | <a href="/headers/sitemap-url/">Sitemap-URL</a> |
| get_canonical_link() | <a href="https://documentation.uriel.foo/headers/sitemap-url/">Sitemap-URL</a> |
| get_link_prefix() | <p> |
| get_link_suffix() | </p> |
| get_tags() | ['root-node', 'sitemap', 'sitemap-headers'] |
| get_dest_dir() | ./public/headers/sitemap-url |
| get_dest_file() | ./public/headers/sitemap-url/index.html |
| get_breadcrumb_separator() | » |