aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-05-24 10:47:31 +0100
committerMichael Williamson <mike@zwobble.org>2026-05-24 10:47:31 +0100
commit1a495a98856180e25d3b166b51319b165e0ce348 (patch)
treebac9bcf58540a87279fa9470c44f33b17abfe491
parentee59684d2abb3b08f4eb344b9e0994bed8335617 (diff)
Add note on performance
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 87d6143..1d05562 100644
--- a/README.md
+++ b/README.md
@@ -545,6 +545,13 @@ For instance:
To enable access when converting trusted source documents,
set `options.externalFileAccess` to `true`.
+* The conversion may exhibit pathological performance on certain documents:
+ it's likely possible to craft a source document that causes high CPU or memory usage.
+ Depending on the performance constraints of your application and the likelihood of receiving untrusted input,
+ you may wish to consider isolating any calls to Mammoth,
+ such as running Mammoth in a separate thread with a timeout,
+ to prevent denial-of-service attacks.
+
### Document transforms
**The API for document transforms should be considered unstable,