diff --git a/Dockerfile b/Dockerfile index 7dcd0d5..3aa0705 100644 --- a/Dockerfile +++ b/Dockerfile @@ -27,9 +27,13 @@ ARG BASE_URL ENV BASE_URL=$BASE_URL RUN if [ -z "$BASE_URL" ]; then \ - npm run build -- --mode production; \ + npm run build -- --mode production && \ + npm run docs:build && \ + node scripts/include-docs-in-dist.js; \ else \ - npm run build -- --base=${BASE_URL} --mode production; \ + npm run build -- --base=${BASE_URL} --mode production && \ + npm run docs:build && \ + node scripts/include-docs-in-dist.js; \ fi # Production stage diff --git a/README.md b/README.md index 192e915..3b583e2 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@
+
+
+
+
+ Configure external processing modules (PyMuPDF, Ghostscript, + CoherentPDF) +
+- This software includes components licensed under the - GNU AGPL v3, including: -
-+ BentoPDF + does not bundle AGPL-licensed + processing libraries. The following components must be configured + separately via + Advanced Settings if you wish + to use their features: +
++ To enable features powered by these libraries: +
++ + The commercial license covers + BentoPDF's own code only. It + does not bypass the AGPL licensing of these components. Users must + comply with the AGPL v3 terms for these components. +
+This PDF has no layers (OCG).
Add a new layer to get started!
External processing module needed
++ This feature requires ${displayName} to be configured. +
+ +Features enabled by this module:
++ This module is licensed under AGPL-3.0. By configuring it, you agree to its license terms. +
++ Converts the PDF to images first, ensuring better PDF/A + compliance. Recommended if validation fails on the normal + conversion. +
++ Configure external processing modules to enable advanced PDF features. + These modules are optional and licensed separately. +
+ + ++ Why is this needed? Some advanced features + require external processing modules that are licensed under + AGPL-3.0. By providing your own module URLs, you can enable + these features. +
+Document Processing Engine
++ Enables: PDF to Text, Markdown, SVG, DOCX, Excel β’ Extract + Images/Tables β’ Format Conversion +
+https://cdn.jsdelivr.net/npm/@bentopdf/pymupdf-wasm@0.1.9/
+
+ PDF/A Conversion Engine
++ Enables: PDF/A-1b, PDF/A-2b, PDF/A-3b Conversion β’ Font to Outline +
+https://cdn.jsdelivr.net/npm/@bentopdf/gs-wasm/assets/
+
+ Bookmarks & Metadata Engine
++ Enables: Split by Bookmarks β’ Edit Bookmarks β’ PDF Metadata +
+https://cdn.jsdelivr.net/npm/coherentpdf/dist/
+
+ + License Notice: The external + modules (PyMuPDF, Ghostscript, CoherentPDF) are licensed under + AGPL-3.0 or similar copyleft licenses. By configuring and using + these modules, you agree to their respective license terms. BentoPDF + is compatible with any Ghostscript WASM and PyMuPDF WASM + implementation that follows the expected interface. +
++ Processing... +
+