summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-05-24 10:47:57 +0100
committerMichael Williamson <mike@zwobble.org>2026-05-24 10:47:57 +0100
commit227d04c7c302fbf38d4b2501090078377b1bcfd1 (patch)
tree2c94e0d4947932fe6789374ba5aa160414c9be82
parentf0527d811efc317cea4367dad8c6cb09e5131e4c (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 4e085dd..4978816 100644
--- a/README.md
+++ b/README.md
@@ -335,6 +335,13 @@ For instance:
To enable access when converting trusted source documents,
call `enableExternalFileAccess()`.
+* 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.
+
## Writing style maps
A style map is made up of a number of style mappings separated by new lines.