Skip to content

Commit

Permalink
Remove references to symlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring committed May 12, 2024
1 parent 1d5f40c commit f31741b
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 4 deletions.
1 change: 0 additions & 1 deletion content/en/about/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ But when developing and building your site, the runtime is the `hugo` executable
**Hugo's main approach is that of sandboxing and a security policy with strict defaults:**

* Hugo has a virtual file system and only the main project (not third-party components) is allowed to mount directories or files outside the project root.
* Only the main project can walk symbolic links.
* User-defined components have read-only access to the filesystem.
* We shell out to some external binaries to support [Asciidoctor](/content-management/formats/#formats) and similar, but those binaries and their flags are predefined and disabled by default (see [Security Policy](#security-policy)). General functions to run arbitrary external OS commands have been [discussed](https://github.com/gohugoio/hugo/issues/796), but not implemented because of security concerns.

Expand Down
2 changes: 1 addition & 1 deletion content/en/getting-started/directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ target = 'content'
{{% note %}}
When you overlay one directory on top of another, you must mount both directories.

If you think you need a symbolic link in your project directory, use Hugo's union file system instead.
Hugo does not follow symbolic links. If you need the functionality provided by symbolic links, use Hugo's union file system instead.
{{% /note %}}

After mounting, the union file system has this structure:
Expand Down
2 changes: 1 addition & 1 deletion content/en/hugo-modules/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ When you add a mount, the default mount for the concerned target root is ignored
{{< /code-toggle >}}

source
: The source directory of the mount. For the main project, this can be either project-relative or absolute and even a symbolic link. For other modules it must be project-relative.
: The source directory of the mount. For the main project, this can be either project-relative or absolute. For other modules it must be project-relative.

target
: Where it should be mounted into Hugo's virtual filesystem. It must start with one of Hugo's component folders: `static`, `content`, `layouts`, `data`, `assets`, `i18n`, or `archetypes`. E.g. `content/blog`.
Expand Down
2 changes: 1 addition & 1 deletion content/en/templates/data-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ Retrieve remote data using these template functions:

## LiveReload with data files

There is no chance to trigger a [LiveReload] when the content of a URL changes. However, when a *local* file changes (i.e., `data/*` and `themes/<THEME>/data/*`), a LiveReload will be triggered. Symlinks are not supported. Note too that because downloading data takes a while, Hugo stops processing your Markdown files until the data download has been completed.
There is no chance to trigger a [LiveReload] when the content of a URL changes. However, when a *local* file changes (i.e., `data/*` and `themes/<THEME>/data/*`), a LiveReload will be triggered. Note too that because downloading data takes a while, Hugo stops processing your Markdown files until the data download has been completed.

{{% note %}}
If you change any local file and the LiveReload is triggered, Hugo will read the data-driven (URL) content from the cache. If you have disabled the cache (i.e., by running the server with `hugo server --ignoreCache`), Hugo will re-download the content every time LiveReload triggers. This can create *huge* traffic. You may reach API limits quickly.
Expand Down

0 comments on commit f31741b

Please sign in to comment.