aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Williamson <mike@zwobble.org>2026-05-24 10:47:48 +0100
committerMichael Williamson <mike@zwobble.org>2026-05-24 10:47:48 +0100
commit1cac2458ea3c0a68754f1cc86df3aee50b02782b (patch)
tree72206673fbc6fb288b20a66a51a1039e7f199ebb
parent8501d6933779be1804b873bad80815193f3d5ee9 (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 39efcbf..3b90e30 100644
--- a/README.md
+++ b/README.md
@@ -424,6 +424,13 @@ For instance:
To enable access when converting trusted source documents,
pass `external_file_access=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,