From 61dc4b8bb86295f8f16bc48327d96ae3ad88541e Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Wed, 27 Mar 2019 11:44:42 +0100 Subject: [PATCH] improving documentation about Kubernetes (fixes #40 #53) --- build/docs/content/01-install.md | 5 +++++ build/docs/content/08-filename.md | 15 +-------------- docs/index.html | 23 +++++++---------------- 3 files changed, 13 insertions(+), 30 deletions(-) diff --git a/build/docs/content/01-install.md b/build/docs/content/01-install.md index 1b2b4c71..89c05589 100644 --- a/build/docs/content/01-install.md +++ b/build/docs/content/01-install.md @@ -29,6 +29,11 @@ services: It may also be deployed with Kubernetes. +> In Kubernetes, make sure to provide enough memory and CPU requests (for instance `512Mi` and `0.2` CPU). +> Otherwise the API will not be able to launch Google Chrome and Libreoffice (unoconv). +> +> Also note the more resources are granted, the quicker will be the conversions. + In the following examples, we will assume your Gotenberg API is available at [http://localhost:3000](http://localhost:3000). diff --git a/build/docs/content/08-filename.md b/build/docs/content/08-filename.md index 225cb7b5..22ee347c 100644 --- a/build/docs/content/08-filename.md +++ b/build/docs/content/08-filename.md @@ -11,17 +11,4 @@ Otherwise a random filename is used. > However, you may hijack the response from the API or store the resulting PDF > using a custom filename. > -> **Attention:** this feature does not work if the form field `webhookURL` is given. - -## Examples - -### cURL - -```bash -$ curl --request POST \ - --url http://localhost:3000/convert/html \ - --header 'Content-Type: multipart/form-data' \ - --form files=@index.html \ - --form filename='result.pdf' \ - -o result.pdf -``` \ No newline at end of file +> **Attention:** this feature does not work if the form field `webhookURL` is given. \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 7efaf391..f45309d2 100755 --- a/docs/index.html +++ b/docs/index.html @@ -149,6 +149,13 @@

It may also be deployed with Kubernetes.

+
+

In Kubernetes, make sure to provide enough memory and CPU requests (for instance 512Mi and 0.2 CPU). +Otherwise the API will not be able to launch Google Chrome and Libreoffice (unoconv).

+ +

Also note the more resources are granted, the quicker will be the conversions.

+
+

In the following examples, we will assume your Gotenberg API is available at http://localhost:3000.

@@ -919,22 +926,6 @@ using a custom filename.

Attention: this feature does not work if the form field webhookURL is given.

-

Examples

- -

cURL

- -
$ curl --request POST \
-    --url http://localhost:3000/convert/html \
-    --header 'Content-Type: multipart/form-data' \
-    --form files=@index.html \
-    --form filename='result.pdf' \
-    -o result.pdf
-
-