adding moar favicons

adding liveness section in documentation
Merge pull request #32 from Peltoche/master
2026-08-08 08:32:16 +01:00 · 2019-01-03 16:02:02 +01:00 · 2019-01-03 15:56:53 +01:00 · 2019-01-03 15:37:18 +01:00 · 2019-01-03 15:21:57 +01:00
25 changed files with 77 additions and 5 deletions
--- a/build/docs/content/08-liveness.md
+++ b/build/docs/content/08-liveness.md
@@ -0,0 +1,11 @@
+---
+title: Liveness
+---
+
+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/)
--- a/build/docs/content/09-links.md
+++ b/build/docs/content/09-links.md
--- a/docs/index.html
+++ b/docs/index.html
@@ -3,8 +3,19 @@
    <meta http-equiv="x-ua-compatible" content="ie=edge"/>
    <meta name="viewport" content="width=device-width, initial-scale=1"/>
    <title>Gotenberg · A Docker-powered stateless API for converting HTML, Markdown and Office documents to PDF.</title>
+    <link rel="apple-touch-icon-precomposed" sizes="57x57" href="theme/gotenberg/img/apple-touch-icon-57x57.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="theme/gotenberg/img/apple-touch-icon-114x114.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="theme/gotenberg/img/apple-touch-icon-72x72.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="theme/gotenberg/img/apple-touch-icon-144x144.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="60x60" href="theme/gotenberg/img/apple-touch-icon-60x60.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="120x120" href="theme/gotenberg/img/apple-touch-icon-120x120.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="76x76" href="theme/gotenberg/img/apple-touch-icon-76x76.png"/>
+    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="theme/gotenberg/img/apple-touch-icon-152x152.png"/>
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-196x196.png" sizes="196x196"/>
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-96x96.png" sizes="96x96"/>
    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-32x32.png" sizes="32x32"/>
-  <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-16x16.png" sizes="16x16"/>
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-16x16.png" sizes="16x16"/>
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-128.png" sizes="128x128"/>
    <link rel="stylesheet" href="theme/gotenberg/css/index.css"/>
  </head>
  <body>
@@ -54,6 +65,10 @@
                  <a href="#scalability">Scalability</a>
                </div>
              
+                <div class="item">
+                  <a href="#liveness">Liveness</a>
+                </div>
+              
                <div class="item">
                  <a href="#links">Links</a>
                </div>
@@ -105,7 +120,7 @@
 </span><span class="w">
 </span><span class="w">  </span>gotenberg<span class="p">:</span><span class="w">
 </span><span class="w">    </span>image<span class="p">:</span><span class="w"> </span>thecodingmachine/gotenberg<span class="p">:</span><span class="m">3</span><span class="w">
-</span><span class="w"></span></pre>
+</span></pre>

 <blockquote>
 <p>The API will be available under <code>gotenberg:3000</code> in your Docker Compose network.</p>
@@ -695,7 +710,7 @@ $filename = $client-&gt;store($request, $dirPath);
 <pre class="chroma"><span class="k">FROM</span><span class="s"> thecodingmachine/gotenberg:3</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><span class="err"></span></pre>
+</span></pre>

              </div>
            
@@ -834,7 +849,7 @@ $resp = $client-&gt;post($request);
 </span><span class="w">
 </span><span class="w">  </span>gotenberg<span class="p">:</span><span class="w">
 </span><span class="w">    </span>image<span class="p">:</span><span class="w"> </span>thecodingmachine/gotenberg<span class="p">:</span><span class="m">3</span><span class="w">
-</span><span class="w"></span></pre>
+</span></pre>

 <p>You may now launch your services using:</p>

@@ -846,6 +861,22 @@ redirect a request to a Gotenberg container according to the round-robin strateg

              </div>
            
+              <div class="Page" id="liveness">
+                <h1 class="Heading"><a class="Anchor" aria-hidden="true" id="liveness" href="#liveness">
+	<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>Liveness</h1>
+                <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>
+
+              </div>
+            
              <div class="Page" id="links">
                <h1 class="Heading"><a class="Anchor" aria-hidden="true" id="links" href="#links">
 	<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/docs/theme/gotenberg/img/apple-touch-icon-114x114.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-114x114.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-120x120.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-120x120.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-144x144.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-144x144.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-152x152.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-152x152.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-57x57.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-57x57.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-60x60.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-60x60.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-72x72.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-72x72.png
--- a/docs/theme/gotenberg/img/apple-touch-icon-76x76.png
+++ b/docs/theme/gotenberg/img/apple-touch-icon-76x76.png
--- a/docs/theme/gotenberg/img/favicon-128.png
+++ b/docs/theme/gotenberg/img/favicon-128.png
--- a/docs/theme/gotenberg/img/favicon-16x16.png
+++ b/docs/theme/gotenberg/img/favicon-16x16.png
--- a/docs/theme/gotenberg/img/favicon-196x196.png
+++ b/docs/theme/gotenberg/img/favicon-196x196.png
--- a/docs/theme/gotenberg/img/favicon-32x32.png
+++ b/docs/theme/gotenberg/img/favicon-32x32.png
--- a/docs/theme/gotenberg/img/favicon-96x96.png
+++ b/docs/theme/gotenberg/img/favicon-96x96.png
--- a/docs/theme/gotenberg/img/favicon.ico
+++ b/docs/theme/gotenberg/img/favicon.ico
--- a/docs/theme/gotenberg/img/mstile-144x144.png
+++ b/docs/theme/gotenberg/img/mstile-144x144.png
--- a/docs/theme/gotenberg/img/mstile-150x150.png
+++ b/docs/theme/gotenberg/img/mstile-150x150.png
--- a/docs/theme/gotenberg/img/mstile-310x150.png
+++ b/docs/theme/gotenberg/img/mstile-310x150.png
--- a/docs/theme/gotenberg/img/mstile-310x310.png
+++ b/docs/theme/gotenberg/img/mstile-310x310.png
--- a/docs/theme/gotenberg/img/mstile-70x70.png
+++ b/docs/theme/gotenberg/img/mstile-70x70.png
--- a/docs/theme/gotenberg/views/index.html
+++ b/docs/theme/gotenberg/views/index.html
@@ -5,8 +5,19 @@
    <meta http-equiv="x-ua-compatible" content="ie=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>{{.Title}} &#183; {{.Subtitle}}</title>
+    <link rel="apple-touch-icon-precomposed" sizes="57x57" href="theme/gotenberg/img/apple-touch-icon-57x57.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="114x114" href="theme/gotenberg/img/apple-touch-icon-114x114.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="72x72" href="theme/gotenberg/img/apple-touch-icon-72x72.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="144x144" href="theme/gotenberg/img/apple-touch-icon-144x144.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="60x60" href="theme/gotenberg/img/apple-touch-icon-60x60.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="120x120" href="theme/gotenberg/img/apple-touch-icon-120x120.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="76x76" href="theme/gotenberg/img/apple-touch-icon-76x76.png" />
+    <link rel="apple-touch-icon-precomposed" sizes="152x152" href="theme/gotenberg/img/apple-touch-icon-152x152.png" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-196x196.png" sizes="196x196" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-96x96.png" sizes="96x96" />
    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-32x32.png" sizes="32x32" />
-  <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-16x16.png" sizes="16x16" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-16x16.png" sizes="16x16" />
+    <link rel="icon" type="image/png" href="theme/gotenberg/img/favicon-128.png" sizes="128x128" />
    <link rel="stylesheet" href="theme/gotenberg/css/index.css">
  </head>
  <body>
--- a/internal/app/api/api.go
+++ b/internal/app/api/api.go
@@ -67,6 +67,7 @@ func setup() *echo.Echo {
 			return nil
 		}
 	})
+	e.GET("/ping", func(c echo.Context) error { return nil })
 	e.POST("/merge", merge)
 	g := e.Group("/convert")
 	g.POST("/html", convertHTML)
--- a/internal/app/api/api_test.go
+++ b/internal/app/api/api_test.go
@@ -0,0 +1,18 @@
+package api
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/labstack/echo"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestPing(t *testing.T) {
+	req := httptest.NewRequest(http.MethodGet, "/ping", nil)
+	rec := httptest.NewRecorder()
+	e := echo.New()
+	_ = e.NewContext(req, rec)
+	assert.Equal(t, http.StatusOK, rec.Code)
+}
Author	SHA1	Message	Date
Julien Neuhart	2648992a9b	adding moar favicons	2019-01-03 16:02:02 +01:00
Julien Neuhart	7bcc3d081e	adding liveness section in documentation	2019-01-03 15:56:53 +01:00
Julien Neuhart	affd1c45ca	Merge pull request #32 from Peltoche/master Add a /ping endpoint	2019-01-03 15:37:18 +01:00
Peltoche	8c7458812d	Add a /ping endpoint This endpoint can be used to check the service liveness. It can be used for the kubernetes liveness and readiness probs.	2019-01-03 15:21:57 +01:00