aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2025-09-19 11:15:02 +0100
committerMichael Williamson <mike@zwobble.org>2025-09-19 11:15:02 +0100
commitc54aaeb43a7941317c1f3c119ffa92090f988820 (patch)
treef0598b4597e9d9e8f16120563a79839b845ca611 /README.md
parentc6f51699f86176276ffc6d22f2cd0a2b1c592c3e (diff)
Disable external file access by default
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index 9c34147..f2b9d48 100644
--- a/README.md
+++ b/README.md
@@ -377,9 +377,9 @@ Converts the source document to HTML.
set `options.includeDefaultStyleMap` to `false`.
* `externalFileAccess`: Source documents may reference files outside of the source document.
- To disable access to any such external files during the conversion process,
- set `options.externalFileAccess` to `false`.
- This is highly recommended when converting untrusted user input.
+ Access to any such external files is disabled by default.
+ To enable access when converting trusted source documents,
+ set `options.externalFileAccess` to `true`.
* `convertImage`: by default, images are converted to `<img>` elements with the source included inline in the `src` attribute.
Set this option to an [image converter](#image-converters) to override the default behaviour.
@@ -541,8 +541,9 @@ For instance:
and embed the HTML into your website,
this may allow arbitrary files on the server to be read and exfiltrated.
- To disable access to any such external files during the conversion process,
- set `options.externalFileAccess` to `false`.
+ To avoid this issue, access to any such external files is disabled by default.
+ To enable access when converting trusted source documents,
+ set `options.externalFileAccess` to `true`.
### Document transforms