Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions doc/docker.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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`
Expand Down
17 changes: 9 additions & 8 deletions doc/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
17 changes: 10 additions & 7 deletions settings.json.docker
Original file line number Diff line number Diff line change
Expand Up @@ -424,18 +424,21 @@
"maxAge": "${MAX_AGE:21600}", // 60 * 60 * 6 = 6 hours

/*
* This is the absolute path to the soffice executable.
* Absolute path to the soffice (LibreOffice) executable.
*
* LibreOffice is used 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.
* When configured, soffice handles all advanced office-format
* conversions (docx, pdf, odt, doc, rtf -- both directions). When
* null, Etherpad falls back to pure-JS in-process converters
* that handle docx export, pdf export, and docx import natively.
* odt/doc/rtf export and pdf import still require soffice.
*/
"soffice": "${SOFFICE:null}",

/*
* When true (the default), the "Microsoft Word" export button downloads a .docx file via
* LibreOffice (requires "soffice" to be set). Set to false to revert to legacy .doc output
* (which also requires "soffice").
* When true (the default), the "Microsoft Word" export button
* downloads a .docx file -- via soffice if it's configured, or via
* the in-process html-to-docx converter otherwise. Set to false to
* revert to legacy .doc output (.doc still requires soffice).
*/
"docxExport": "${DOCX_EXPORT:true}",

Expand Down
17 changes: 10 additions & 7 deletions settings.json.template
Original file line number Diff line number Diff line change
Expand Up @@ -422,18 +422,21 @@
"maxAge": 21600, // 60 * 60 * 6 = 6 hours

/*
* This is the absolute path to the soffice executable.
* Absolute path to the soffice (LibreOffice) executable.
*
* LibreOffice is used 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.
* When configured, soffice handles all advanced office-format
* conversions (docx, pdf, odt, doc, rtf — both directions). When
* null, Etherpad falls back to pure-JS in-process converters
* that handle docx export, pdf export, and docx import natively.
* odt/doc/rtf export and pdf import still require soffice.
*/
"soffice": null,

/*
* When true (the default), the "Microsoft Word" export button downloads a .docx file via
* LibreOffice (requires "soffice" to be set). Set to false to revert to legacy .doc output
* (which also requires "soffice").
* When true (the default), the "Microsoft Word" export button
* downloads a .docx file -- via soffice if it's configured, or via
* the in-process html-to-docx converter otherwise. Set to false to
* revert to legacy .doc output (.doc still requires soffice).
*/
"docxExport": true,

Expand Down
Loading