aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2025-09-19 14:22:05 +0100
committerMichael Williamson <mike@zwobble.org>2025-09-19 14:22:56 +0100
commit2d226bd2a8b2100d67a29f1696d35abcd290bc33 (patch)
treea87885c6aae2474395381ae70cabf36b9790697b
parent5391908ab339c9431d3f87fe201cf75e7ceecec0 (diff)
Add docs for external file access
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 968d5e9..8235b6e 100644
--- a/README.md
+++ b/README.md
@@ -250,6 +250,10 @@ Methods:
if the document contains an embedded style map, then it is combined with the default style map.
Call this to ignore any embedded style maps.
+* `DocumentConverter EnableExternalFileAccess()`: Source documents may reference files outside of the source document.
+ Access to any such external files is disabled by default.
+ Call this to enable access when converting trusted source documents.
+
* `DocumentConverter PreserveEmptyParagraphs()`: by default, empty paragraphs are ignored.
Call this to preserve empty paragraphs in the output.
@@ -321,6 +325,10 @@ For instance:
and embed the HTML into your website,
this may allow arbitrary files on the server to be read and exfiltrated.
+ To avoid this issue, access to any such external files is disabled by default.
+ To enable access when converting trusted source documents,
+ call `EnableExternalFileAccess()`.
+
## Writing style maps
A style map is made up of a number of style mappings separated by new lines.