Mirrors/etherpad-lite
1
0
Fork 0
mirror of https://github.com/ether/etherpad-lite.git synced 2026-07-17 16:47:05 +00:00
Code Issues Projects Releases Wiki Activity

docs(7538): soffice is now optional for docx/pdf (#7707)

Browse source 
Native DOCX export, PDF export, and DOCX import shipped in #7568
via pure-JS in-process converters -- LibreOffice/soffice is no
longer required for those formats. Stale comments in
settings.json.template and settings.json.docker still implied
otherwise ("will only allow plain text and HTML import/exports"),
and the docker docs told users to configure soffice for DOCX as
well. Update them to match what's actually in core:

- soffice present: handles all office formats (existing behavior)
- soffice null: docx export, pdf export, docx import work
  natively; odt/doc/rtf export and pdf import still need soffice

Touches:
- settings.json.template (soffice + docxExport comments)
- settings.json.docker (same)
- doc/docker.md ("Office-format import/export" section)
- doc/docker.adoc (same section + the SOFFICE table row,
  matching what doc/docker.md already says since #7568)

No code changes, no behavior change -- documentation only.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
John McLear 2026-05-09 18:29:43 +08:00 • committed by GitHub
parent fd2f3baf55
commit ed4579c701
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 39 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/docker.adoc
View file

@ -62,16 +62,17 @@ The variable value has to be a space separated, double quoted list of plugin nam
Some plugins will need personalized settings. Just refer to the previous section, and include them in your custom `settings.json.docker`.
==== Rebuilding including export functionality for DOC/DOCX/PDF/ODT
==== Office-format import/export
If you want to be able to export your pads to DOC/DOCX/PDF/ODT files, you can
install Libreoffice via setting the `INSTALL_SOFFICE` build variable to any
value.
DOCX export, PDF export, and DOCX import work out of the box — Etherpad
ships pure-JS in-process converters and needs no extra dependencies for
those three formats.
Also, you will need to configure the path to the libreoffice executable
via setting the `soffice` property in `<BASEDIR>/settings.json.docker` to
`/usr/bin/soffice` or via setting the environment variable `SOFFICE` to
`/usr/bin/soffice`.
DOC/ODT/RTF export and PDF import still require LibreOffice. To enable
them, install LibreOffice via the `INSTALL_SOFFICE` build variable (any
value), and either set the `soffice` property in
`<BASEDIR>/settings.json.docker` to `/usr/bin/soffice` or set the
`SOFFICE` environment variable to `/usr/bin/soffice`.
==== Examples
@ -452,7 +453,7 @@ For the editor container, you can also make it full width by adding `full-width-
| `21600` (6 hours)
| `SOFFICE`
| Absolute path to the soffice (LibreOffice) executable. Needed for advanced import/export of pads (docx, pdf, odt). Setting it to null disables LibreOffice and will only allow plain text and HTML import/exports.
| Absolute path to the soffice (LibreOffice) executable. When configured, all advanced import/export formats use it (docx, pdf, odt, doc, rtf). Setting it to null falls back to in-process pure-JS converters: docx and pdf export, plus docx import, still work; odt/doc/rtf and pdf import remain unavailable.
| `null`
| `ALLOW_UNKNOWN_FILE_ENDS`

17
doc/docker.md
View file

@ -35,16 +35,17 @@ The variable value has to be a space separated, double quoted list of plugin nam
Some plugins will need personalized settings. Just refer to the previous section, and include them in your custom `settings.json.docker`.
### Rebuilding including export functionality for DOC/DOCX/PDF/ODT
### Office-format import/export
If you want to be able to export your pads to DOC/DOCX/PDF/ODT files, you can
install Libreoffice via setting the `INSTALL_SOFFICE` build variable to any
value.
DOCX export, PDF export, and DOCX import work out of the box — Etherpad
ships pure-JS in-process converters and needs no extra dependencies for
those three formats.
Also, you will need to configure the path to the libreoffice executable
via setting the `soffice` property in `<BASEDIR>/settings.json.docker` to
`/usr/bin/soffice` or via setting the environment variable `SOFFICE` to
`/usr/bin/soffice`.
DOC/ODT/RTF export and PDF import still require LibreOffice. To enable
them, install LibreOffice via the `INSTALL_SOFFICE` build variable (any
value), and either set the `soffice` property in
`<BASEDIR>/settings.json.docker` to `/usr/bin/soffice` or set the
`SOFFICE` environment variable to `/usr/bin/soffice`.
### Examples