Skip to content

Commit

Permalink
feat: update doccumentation fro Gotenberg 7.10.2
Browse files Browse the repository at this point in the history
  • Loading branch information
@gulien
gulien committed Dec 18, 2023
1 parent 337adf2 commit 3716a71
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 15 deletions.
7 changes: 4 additions & 3 deletions docs/configuration.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ The following flags allow you to configure the API module:
| Flag | Description | Default |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | --------------- |
| <span class="badge badge--secondary">--api-port</span> | Set the port on which the API should listen. | 3000 |
| <span class="badge badge--secondary">--api-port-from-env</span> | Set the environment variable with the port on which the API should listen - override the default port. | None |
| <span class="badge badge--secondary">--api-port-from-env</span> | Set the environment variable with the port on which the API should listen - override the default port. | None |
| <span class="badge badge--secondary">--api-start-timeout</span> | Set the time limit for the API to start. | 30s |
| <span class="badge badge--secondary">--api-timeout</span> | Set the time limit for requests. | 30s |
| <span class="badge badge--secondary">--api-root-path</span> | Set the root path of the API - for service discovery via URL paths. | / |
| <span class="badge badge--secondary">--api-trace-header</span> | Set the header name to use for identifying requests. | Gotenberg-Trace |
Expand Down Expand Up @@ -45,7 +46,7 @@ The following flags allow you to configure the Chromium module:
| ----------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| <span class="badge badge--secondary">--chromium-restart-after</span> | Number of conversions after which Chromium will automatically restart. Set to 0 to disable this feature. | 0 |
| <span class="badge badge--secondary">--chromium-auto-start</span> | Automatically launch Chromium upon initialization if set to true; otherwise, Chromium will start at the time of the first conversion. | false |
| <span class="badge badge--secondary">--chromium-start-timeout</span> | Maximum duration to wait for Chromium to start or restart. | 10s |
| <span class="badge badge--secondary">--chromium-start-timeout</span> | Maximum duration to wait for Chromium to start or restart. | 20s |
| <span class="badge badge--secondary">--chromium-allow-file-access-from-files</span> | Allow file:// URIs to read other file:// URIs. | false |
| <span class="badge badge--secondary">--chromium-allow-insecure-localhost</span> | Ignore TLS/SSL errors on localhost. | false |
| <span class="badge badge--secondary">--chromium-allow-list</span> | Set the allowed URLs for Chromium using a regular expression. | All |
Expand Down Expand Up @@ -74,7 +75,7 @@ The following flags allow you to configure the LibreOffice module:
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| <span class="badge badge--secondary">--libreoffice-restart-after</span> | Number of conversions after which LibreOffice will automatically restart. Set to 0 to disable this feature. | 10 |
| <span class="badge badge--secondary">--libreoffice-auto-start</span> | Automatically launch LibreOffice upon initialization if set to true; otherwise, LibreOffice will start at the time of the first conversion. | false |
| <span class="badge badge--secondary">--libreoffice-start-timeout</span> | Maximum duration to wait for LibreOffice to start or restart. | 10s |
| <span class="badge badge--secondary">--libreoffice-start-timeout</span> | Maximum duration to wait for LibreOffice to start or restart. | 20s |
| <span class="badge badge--secondary">--libreoffice-disable-routes</span> | Disable the route. | false |

### Switch Language
Expand Down
16 changes: 8 additions & 8 deletions docs/routes.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ Each route accepts the following form fields:

At present, the following PDF/A formats are available:

* `PDF/A-1a`
* `PDF/A-1b`
* `PDF/A-2b`
* `PDF/A-3b`

Expand All @@ -761,7 +761,7 @@ values={[
curl \
--request POST 'http://localhost:3000/forms/chromium/convert/url' \
--form 'url="https://my.url"' \
--form 'pdfa="PDF/A-1a"' \
--form 'pdfa="PDF/A-1b"' \
--form 'pdfua="true' \
-o my.pdf
```
Expand Down Expand Up @@ -1025,7 +1025,7 @@ The route also accepts the following form fields:

At present, the following PDF/A formats are available:

* `PDF/A-1a`
* `PDF/A-1b`
* `PDF/A-2b`
* `PDF/A-3b`

Expand All @@ -1041,7 +1041,7 @@ values={[
curl \
--request POST 'http://localhost:3000/forms/libreoffice/convert' \
--form 'files=@"/path/to/file.docx"' \
--form 'pdfa="PDF/A-1a"' \
--form 'pdfa="PDF/A-1b"' \
--form 'pdfua="true"' \
-o my.pdf
```
Expand Down Expand Up @@ -1069,7 +1069,7 @@ Note that at least one of the form field must be provided.\*

At present, the following PDF/A formats are available:

* `PDF/A-1a`
* `PDF/A-1b`
* `PDF/A-2b`
* `PDF/A-3b`

Expand All @@ -1085,7 +1085,7 @@ values={[
curl \
--request POST 'http://localhost:3000/forms/pdfengines/convert' \
--form 'files=@"/path/to/pdf.pdf"' \
--form 'pdfa="PDF/A-1a"' \
--form 'pdfa="PDF/A-1b"' \
--form 'pdfua="true"' \
-o my.pdf
```
Expand All @@ -1108,7 +1108,7 @@ curl \
--form 'files=@"/path/to/pdf2.pdf"' \
--form 'files=@"/path/to/pdf3.pdf"' \
--form 'files=@"/path/to/pdf4.pdf"' \
--form 'pdfa="PDF/A-1a"' \
--form 'pdfa="PDF/A-1b"' \
--form 'pdfua="true"' \
-o my.zip
```
Expand Down Expand Up @@ -1180,7 +1180,7 @@ POST /forms/pdfengines/merge

At present, the following PDF/A formats are available:

* `PDF/A-1a`
* `PDF/A-1b`
* `PDF/A-2b`
* `PDF/A-3b`

Expand Down
12 changes: 9 additions & 3 deletions docs/troubleshooting.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,17 @@ If you are experiencing timeouts (i.e., *503 Service Unavailable*), consider the

## LibreOffice

### Filenames with Non-Latin Characters
### PDF/A-1a

Ensure that filenames are encoded in *UTF-8*.
Beginning with version 7.6, LibreOffice has discontinued support for `PDF/A-1a`.

For additional details, refer to issue [#427](https://github.com/gotenberg/gotenberg/issues/427).
Previously, LibreOffice claimed to generate `PDF/A-1a` files, a claim that held true for straightforward documents.
However, in many instances, the software was actually producing `PDF/A-1b` files.

Due to specific metadata, some validators incorrectly identified these documents as compliant with `PDF/A-1a` standards,
despite this not being the case.

For additional details, refer to this LibreOffice [commit](https://git.libreoffice.org/core/+/c4b12d06698402984b3ffdbd2c139f261fa35ca1%5E%21).

### Internal Server Error

Expand Down
2 changes: 1 addition & 1 deletion src/components/Highlights.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ curl \\
--form 'files=@"/path/to/file.docx"' \\
--form 'files=@"/path/to/file.xlsx"' \\
--form 'merge="true"' \\
--form 'pdfa="PDF/A-1a"' \\
--form 'pdfa="PDF/A-1b"' \\
-o my.pdf
`;

Expand Down

0 comments on commit 3716a71

Please sign in to comment.