From 84a37f124b771bf1f2b4c3103a618b1b5a3b3a74 Mon Sep 17 00:00:00 2001 From: Julien Neuhart Date: Fri, 6 Dec 2019 17:30:36 +0100 Subject: [PATCH] adding documentation for ROOT_PATH --- build/docs/content/03-environment-variables.md | 12 ++++++++++++ docs/index.html | 16 ++++++++++++++++ 2 files changed, 28 insertions(+) diff --git a/build/docs/content/03-environment-variables.md b/build/docs/content/03-environment-variables.md index e1f18731..b1522740 100644 --- a/build/docs/content/03-environment-variables.md +++ b/build/docs/content/03-environment-variables.md @@ -23,6 +23,18 @@ You may customize this value with the environment variable `DEFAULT_LISTEN_PORT` This environment variable accepts any string that can be turned into a port number. +## Root path + +By default, the API root path is `/`. + +You may customize this value with the environment variable `ROOT_PATH`. + +This environment variable accepts a string starting and ending with `/`. + +For instance, `/gotenberg/` is a valid value while `gotenberg` is not. + +> This is useful if you wish to do service discovery via URL paths. + ## Disable Google Chrome In order to save some resources, the Gotenberg image accepts the environment variable `DISABLE_GOOGLE_CHROME` diff --git a/docs/index.html b/docs/index.html index 85c3b75a..8aca8fff 100755 --- a/docs/index.html +++ b/docs/index.html @@ -264,6 +264,22 @@ about what’s going on.

This environment variable accepts any string that can be turned into a port number.

+

Root path

+ +

By default, the API root path is /.

+ +

You may customize this value with the environment variable ROOT_PATH.

+ +

This environment variable accepts a string starting and ending with /.

+ +

For instance, /gotenberg/ is a valid value while gotenberg is not.

+ +
+

This is useful if you wish to do service discovery via URL paths.

+
+

Disable Google Chrome