Gotenberg
services.gotenberg.chromium.autoStart
Automatically start chromium when Gotenberg starts. If false, Chromium will start on the first conversion request that uses it.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.chromium.disableJavascript
Disable Javascript execution.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.chromium.disableRoutes
Disable all routes allowing Chromium-based conversion.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.chromium.maxQueueSize
Maximum queue size for chromium-based conversions. Setting to 0 disables the limit.
Type: signed integer
Default
0
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.chromium.package
The chromium package to use.
Type: package
Default
pkgs.chromium
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.enable
Whether to enable Gotenberg, a stateless API for PDF files.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.enableBasicAuth
HTTP Basic Authentication.
If you set this, be sure to set GOTENBERG_API_BASIC_AUTH_USERNAMEand GOTENBERG_API_BASIC_AUTH_PASSWORD
in your services.gotenberg.environmentFile file.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.environmentFile
Environment file to load extra environment variables from.
Type: null or path
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.extraArgs
Any extra command-line flags to pass to the Gotenberg service.
Type: list of string
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.extraFontPackages
Extra fonts to make available.
Type: list of package
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.libreoffice.autoStart
Automatically start LibreOffice when Gotenberg starts. If false, Chromium will start on the first conversion request that uses it.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.libreoffice.disableRoutes
Disable all routes allowing LibreOffice-based conversion.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.libreoffice.maxQueueSize
Maximum queue size for LibreOffice-based conversions. Setting to 0 disables the limit.
Type: signed integer
Default
0
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.libreoffice.package
The libreoffice package to use.
Type: package
Default
pkgs.libreoffice
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.libreoffice.restartAfter
Restart LibreOffice after this many conversions. Setting to 0 disables this feature.
Type: signed integer
Default
10
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.logLevel
The logging level for Gotenberg.
Type: one of "error", "warn", "info", "debug"
Default
"info"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.package
The gotenberg package to use.
Type: package
Default
pkgs.gotenberg
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.pdfEngines
PDF engines to enable. Each one can be used to perform a specific task. See the documentation for more details. Defaults to all possible PDF engines.
Type: list of (one of "pdftk", "qpdf", "libreoffice-pdfengine", "exiftool", "pdfcpu")
Default
["pdftk""qpdf""libreoffice-pdfengine""exiftool""pdfcpu"]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.port
Port on which the API should listen.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default
3000
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.rootPath
Root path for the Gotenberg API.
Type: string
Default
"/"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix
services.gotenberg.timeout
Timeout for API requests.
Type: null or string
Default
"30s"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/misc/gotenberg.nix