aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2025-09-10 15:55:27 +0100
committerMichael Williamson <mike@zwobble.org>2025-09-10 15:55:27 +0100
commit1494d3c3a6283a00701ac452b8a9a5f8f2f4e9dd (patch)
tree4e4467490b883fe075094a25ba28f05e62d21393 /README.md
parent162324eb530d781aa59acce597997646ee59d1eb (diff)
Support disabling external file access
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index b0d6d49..79a49b3 100644
--- a/README.md
+++ b/README.md
@@ -230,6 +230,18 @@ var options = {
};
```
+#### External file access
+
+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`:
+
+```javascript
+var options = {
+ externalFileAccess: false
+};
+```
+
#### Custom image handlers
By default, images are converted to `<img>` elements with the source included inline in the `src` attribute.
@@ -536,6 +548,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`.
+
### Document transforms
**The API for document transforms should be considered unstable,