improving documentation on timeout issues

build/docs/content/03-environment-variables.md

@@ -42,6 +42,7 @@ You may also disable LibreOffice (unoconv) with `DISABLE_UNOCONV`.
 ## Default wait timeout
 
 By default, the API will wait 10 seconds before it considers the conversion to be unsuccessful.
+If unsucessful, it returns a `504` HTTP code.
 
 You may customize this timeout thanks to the environment variable `DEFAULT_WAIT_TIMEOUT`.
 

build/docs/content/04-html.md

@@ -6,6 +6,13 @@ Gotenberg provides the endpoint `/convert/html` for HTML conversions.
 
 It accepts `POST` requests with a `multipart/form-data` Content-Type.
 
+> **Attention:** currently, Google Chrome headless misbehaves if there are too many concurrent conversions.
+> That's why for HTML, [URL](#url) and [Markdown](#markdown) conversions, the API does only 6 conversions at a time.
+> The more concurrent requests, the more `504` HTTP codes the API will return.
+>
+> See the [scalability section](#scalability) to find how to mitigate this issue.
+> You may also take a look at the [timeout section](#timeout).
+
 ## Basic
 
 The only requirement is to send a file named `index.html`: it is the file

build/docs/content/07-office.md

@@ -6,6 +6,13 @@ Gotenberg provides the endpoint `/convert/office` for Office document conversion
 
 It accepts `POST` requests with a `multipart/form-data` Content-Type.
 
+> **Attention:** currently, `unoconv` cannot perform concurrent conversions.
+> That's why for Office conversions, the API does only one conversion at a time.
+> The more concurrent requests, the more `504` HTTP codes the API will return.
+>
+> See the [scalability section](#scalability) to find how to mitigate this issue.
+> You may also take a look at the [timeout section](#timeout).
+
 ## Basic
 
 You may send one or more Office documents. Following file extensions are accepted:
@@ -25,9 +32,7 @@ You may send one or more Office documents. Following file extensions are accepte
 
 All files will be merged into a single resulting PDF.
 
-> **Attention:** currently, `unoconv` cannot perform concurrent conversions.
+> **Attention:** Gotenberg merges the PDF files alphabetically.
-> That's why for Office conversions, the API does only one conversion at a time.
-> See the [scalability section](#scalability) to find how to mitigate this issue.
 
 ### cURL
 

build/docs/content/09-timeout.md

@@ -5,6 +5,7 @@ title: Timeout
 All endpoints accept a form field named `waitTimeout`.
 
 The API will wait the given **seconds** before it considers the conversion to be unsucessful.
+If unsucessful, it returns a `504` HTTP code.
 
 It takes a float as value (e.g `2.5` for 2.5 seconds).
 

build/docs/content/13-ping.md

@@ -5,11 +5,6 @@ title: Ping
 Gotenberg provides the endpoint `/ping` for checking the API availability with
 a simple `GET` request.
 
-This feature is especially useful for liveness/readiness probes in Kubernetes:
-
-* [Pod lifecycle](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
-* [Configure Liveness and Readiness Probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/)
-
 If `LOG_LEVEL` is `"DEBUG"`, it also returns details about the PM2 processes in JSON format.
 For instance:
 
@@ -39,3 +34,5 @@ For instance:
     }
 ]
 ```
+
+> if `LOG_LEVEL` is NOT `"DEBUG"`, no log entries are written.

build/docs/content/14-fonts.md

@@ -7,7 +7,7 @@ By default, a handful of fonts are installed. Asian characters are also supporte
 If you wish to use more fonts, you will have to create your own image:
 
 ```Dockerfile
-FROM thecodingmachine/gotenberg:5
+FROM thecodingmachine/gotenberg:6
 
 RUN apt-get -y install yourfonts
 ```

docs/index.html

@@ -280,7 +280,8 @@ about what’s going on.</p>
 	<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
 </a>Default wait timeout</h2>
 
-<p>By default, the API will wait 10 seconds before it considers the conversion to be unsuccessful.</p>
+<p>By default, the API will wait 10 seconds before it considers the conversion to be unsuccessful.
+If unsucessful, it returns a <code>504</code> HTTP code.</p>
 
 <p>You may customize this timeout thanks to the environment variable <code>DEFAULT_WAIT_TIMEOUT</code>.</p>
 
@@ -354,6 +355,15 @@ See the <a href="#webhook.timeout">webhook timeout section</a>.</p>
 
 <p>It accepts <code>POST</code> requests with a <code>multipart/form-data</code> Content-Type.</p>
 
+<blockquote>
+<p><strong>Attention:</strong> currently, Google Chrome headless misbehaves if there are too many concurrent conversions.
+That’s why for HTML, <a href="#url">URL</a> and <a href="#markdown">Markdown</a> conversions, the API does only 6 conversions at a time.
+The more concurrent requests, the more <code>504</code> HTTP codes the API will return.</p>
+
+<p>See the <a href="#scalability">scalability section</a> to find how to mitigate this issue.
+You may also take a look at the <a href="#timeout">timeout section</a>.</p>
+</blockquote>
+
 <h2 class="Heading"><a class="Anchor" aria-hidden="true" id="html.basic" href="#html.basic">
 	<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
 </a>Basic</h2>
@@ -874,6 +884,15 @@ $client-&gt;store($request, $dest);
 
 <p>It accepts <code>POST</code> requests with a <code>multipart/form-data</code> Content-Type.</p>
 
+<blockquote>
+<p><strong>Attention:</strong> currently, <code>unoconv</code> cannot perform concurrent conversions.
+That’s why for Office conversions, the API does only one conversion at a time.
+The more concurrent requests, the more <code>504</code> HTTP codes the API will return.</p>
+
+<p>See the <a href="#scalability">scalability section</a> to find how to mitigate this issue.
+You may also take a look at the <a href="#timeout">timeout section</a>.</p>
+</blockquote>
+
 <h2 class="Heading"><a class="Anchor" aria-hidden="true" id="office.basic" href="#office.basic">
 	<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"><path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path></svg>
 </a>Basic</h2>
@@ -898,9 +917,7 @@ $client-&gt;store($request, $dest);
 <p>All files will be merged into a single resulting PDF.</p>
 
 <blockquote>
-<p><strong>Attention:</strong> currently, <code>unoconv</code> cannot perform concurrent conversions.
+<p><strong>Attention:</strong> Gotenberg merges the PDF files alphabetically.</p>
-That’s why for Office conversions, the API does only one conversion at a time.
-See the <a href="#scalability">scalability section</a> to find how to mitigate this issue.</p>
 </blockquote>
 
 <h3 class="Heading"><a class="Anchor" aria-hidden="true" id="office.basic.c_url" href="#office.basic.c_url">
@@ -1073,7 +1090,8 @@ $client-&gt;store($request, $dest);
 </a>Timeout</h1>
                 <p>All endpoints accept a form field named <code>waitTimeout</code>.</p>
 
-<p>The API will wait the given <strong>seconds</strong> before it considers the conversion to be unsucessful.</p>
+<p>The API will wait the given <strong>seconds</strong> before it considers the conversion to be unsucessful.
+If unsucessful, it returns a <code>504</code> HTTP code.</p>
 
 <p>It takes a float as value (e.g <code>2.5</code> for 2.5 seconds).</p>
 
@@ -1342,13 +1360,6 @@ redirect a request to a Gotenberg container according to the round-robin strateg
                 <p>Gotenberg provides the endpoint <code>/ping</code> for checking the API availability with
 a simple <code>GET</code> request.</p>
 
-<p>This feature is especially useful for liveness/readiness probes in Kubernetes:</p>
-
-<ul>
-<li><a href="https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes">Pod lifecycle</a></li>
-<li><a href="https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/">Configure Liveness and Readiness Probes</a></li>
-</ul>
-
 <p>If <code>LOG_LEVEL</code> is <code>&#34;DEBUG&#34;</code>, it also returns details about the PM2 processes in JSON format.
 For instance:</p>
 
@@ -1378,6 +1389,10 @@ For instance:</p>
 <span class="p">]</span>
 </pre>
 
+<blockquote>
+<p>if <code>LOG_LEVEL</code> is NOT <code>&#34;DEBUG&#34;</code>, no log entries are written.</p>
+</blockquote>
+
               </div>
             
               <div class="Page" id="fonts">
@@ -1388,7 +1403,7 @@ For instance:</p>
 
 <p>If you wish to use more fonts, you will have to create your own image:</p>
 
-<pre class="chroma"><span class="k">FROM</span><span class="s"> thecodingmachine/gotenberg:5</span><span class="err">
+<pre class="chroma"><span class="k">FROM</span><span class="s"> thecodingmachine/gotenberg:6</span><span class="err">
 </span><span class="err">
 </span><span class="err"></span><span class="k">RUN</span> apt-get -y install yourfonts<span class="err">
 </span></pre>