String binds a form field to a string variable. var foo string ctx.FormData().String("foo", &foo, "bar")

Error returns the message.

Run executes a provided task while managing the state of the [Process]. Run manages the request queue and may restart the process if it is not health

Bool binds a form field to a bool variable. It populates an error if the value is not bool. var foo bool ctx.FormData().Bool("foo", &foo, true)

Get returns the value stored in the detached store, not the embedded context's pooled store.

Close closes the stream, discard any temporary backing storage.

Tracer returns a [trace.Tracer] with the instrumentation name and version already set.

Duration binds a form field to a time.Duration variable. It populates an error if the form field is not time.Duration. var foo time.Duration ctx.F

Log returns the context [slog.Logger].

NewSentinelHttpError creates a [SentinelHttpError]. The message will be sent as the response's body if returned from a handler, so make sure to not le

WrapError wraps the given error with a [SentinelHttpError]. The wrapped error will be displayed in a log, while the [SentinelHttpError] will be sent i

Set writes to the detached store, not the embedded context's pooled store. This prevents downstream middleware writes from leaking into a later reques

MustBool returns the boolean value of a flag given by name. It panics if an error occurs.

Custom helps to define a custom binding function for a form field. var foo map[string]string ctx.FormData().Custom("foo", func(value string) error

Int binds a form field to an int variable. It populates an error if the value is not int. var foo int ctx.FormData().Int("foo", &foo, 2)

Exec executes the command and waits for its completion or until the context is done. In any case, it kills the unix process and all its children. Whe

CommandContext creates a [Cmd] with a context. It configures the internal [exec.Cmd] of [Cmd] so that we may kill its unix process and all its childre

Request returns the [http.Request].

NewProcessSupervisor initializes a new [ProcessSupervisor]. engine names the managed process (for example "chromium" or "libreoffice") and prefixes th

WithDenyPrivateIPs rejects URLs whose host resolves to a non-public IP address (loopback, RFC1918, link-local, unique-local, multicast, unspecified).

MustStringSlice returns the string slice value of a flag given by name. It panics if an error occurs.

MandatoryPaths binds the absolute paths of form data files, according to a list of file extensions, to a string slice variable. It populates an error

Wait waits for the command to complete. It should be called when using the Start method so that the command does not leak zombies.

spanAttrs returns the client-span attributes for a qpdf invocation: the server address and the qpdf version, plus any extra attributes. The version ri

Printf logs a debug message.

newPinningProxy returns a pinning proxy configured with the given allow/deny lists and IP-class policy. The policy bools are applied via [gotenberg.De

Addr returns the host:port the proxy listens on.

FormData return a [FormData].

Healthy checks the health of the process. It returns true if the process is healthy; otherwise, it returns false.

Write logs the bytes in a debug message.

AddOutputPaths adds the given paths. Those paths will be used later to build the output file.

Error logs a message at the error level using the wrapped slog.Logger.

MustString returns the string value of a flag given by name. It panics if an error occurs.

MustDuration returns the time.Duration value of a flag given by name. It panics if an error occurs.

ReqQueueSize returns the current size of the request queue.

spanAttrs returns the client-span attributes for a pdfcpu invocation: the server address and the pdfcpu version, plus any extra attributes. The versio

spanAttrs returns the client-span attributes for an ExifTool invocation: the server address and the ExifTool version, plus any extra attributes. The v

spanAttrs returns the client-span attributes for a PDFtk invocation: the server address and the PDFtk version, plus any extra attributes. The version

MustRegisterModule registers a module. To register a module, create an init() method in the module main go file: func init() { gotenberg.MustRegi

Rename uses the same signature as [os.Rename].

buildExifToolWriteArgs builds the variadic argv tail for exiftool -overwrite_original <args> <path> from a user-supplied metadata map. Dangerous ps

MustRegexpSlice returns a slice of compiled regular expressions from a string-slice flag given by name. Empty strings are skipped. It panics if an err

SplitHostPort splits a network address hostport of the form "host", "host%zone", "[host]", "[host%zone], "host:port", "host%zone:port", "[host]:port",

Status returns a span status code and message for an HTTP status code value returned by a server.

append adds an error to the list of errors.

runWithFallbackVoid adapts [runWithFallback] for operations that return no value beyond an error.

DecideOutbound parses rawURL, runs the regex allow/deny lists against the normalized form, and (when no allow-list match) resolves the host and applie

MkdirAll uses the same signature as [os.MkdirAll].

Modules return the list of modules which satisfies the requested interface. func (m *YourModule) Provision(ctx *gotenberg.Context) error { mods, _

OriginalFilename returns the original filename associated with a disk path. If no mapping exists, it falls back to [filepath.Base].

runWithFallback runs op against each engine in order and returns the first success. It wraps the attempts in a pdfengines span, records the winning en

WithDenyPublicIPs rejects URLs whose host resolves to a public IP address. Use it on air-gapped or data-governed deployments where Gotenberg must only

Float64 binds a form field to a float64 variable. It populates an error if the value is not float64. var foo float64 ctx.FormData().Float64("foo",

Shutdown stops the managed [Process].

FormDataPdfFacturX extracts the Factur-X parameters and the invoice XML path from form data. Factur-X is requested when both facturxConformanceLevel a

FormDataPdfFormats creates [gotenberg.PdfFormats] from the form data. Fallback to the default value if the considered key is not present.

GeneratePath generates a path within the context's working directory. It generates a new UUID-based filename. It does not create a file.

MustInt64 returns the int64 value of a flag given by name. It panics if an error occurs.

ParsedFlags returns the parsed flags. func (m *YourModule) Provision(ctx *gotenberg.Context) error { flags := ctx.ParsedFlags() m.foo = flags.Re

RestartsCount returns the current number of restart.

URL returns the proxy URL suitable for Chromium's --proxy-server flag. Returns an empty string when the proxy is not listening.

WithContext returns a new [LeveledLogger] with the given context.

mustValue binds the target interface with a form field. If the value is empty or the "key" does not exist, it binds the default value. Currently, only

newProxyForTest returns a pinning proxy whose decide and dial functions are set to test stubs. The proxy is started on a loopback ephemeral port and s

BuildVersion returns the build-time version captured for the module with the given ID. The boolean is false when no version was captured, which is the

ConvertStub transforms a given PDF to the specified formats defined in [gotenberg.PdfFormats]. If no format, it does nothing and returns the input pat

EnsureStampFile validates that, when stamp.Source is image or pdf, an uploaded stamp file was supplied, and replaces stamp.Expression with uploadedFil

EnsureWatermarkFile mirrors [EnsureStampFile] for a watermark. The shape is identical: image or pdf sources must be accompanied by an uploaded file, a

FilterOutboundURL validates that rawURL is acceptable for an outbound request from Gotenberg. It is the URL-aware replacement for [FilterDeadline] and

FormDataPdfEmbeds extracts embedded file paths from form data. Only files uploaded with the "embeds" field name are included.

FormDataPdfEmbedsMetadata extracts embeds metadata from form data. The "embedsMetadata" field is a JSON string keyed by filename.

FormDataPdfEncrypt extracts the encryption parameters and permissions from form data. Permissions default to allowed.

FormDataPdfMetadata creates metadata object from the form data.

FormDataPdfRotate creates rotation parameters from the form data.

FormDataPdfStamp creates a [gotenberg.Stamp] for stamping from the form data.

FormDataPdfStampFile extracts the stamp file path from form data.

FormDataPdfWatermark creates a [gotenberg.Stamp] for watermarking from the form data.

FormDataPdfWatermarkFile extracts the watermark file path from form data.

Inches bind a form field to a float64 variable. It populates an error if the value cannot be computed back to inches. var foo float64 ctx.FormData

MandatoryCustom helps to define a custom binding function for a form field. It populates an error if the value is empty or the "key" does not exist.

Split splits a given PDF file.

injectFacturXIntoXMP splices the fx rdf:Description and the PDF/A extension-schema declaration into an XMP packet. It returns the new packet and wheth

ApplyFacturXStub turns each input PDF into a Factur-X document: it embeds the CII invoice XML under the canonical name with AFRelationship "Alternativ

ConversionsSinceRestart returns the number of tasks handled since the last process (re)start.

DefaultPdfOptions returns the default values for PdfOptions.

EmbedFilesMetadataStub sets metadata on embedded files in PDFs.

FacturXPdfFormats returns the PDF/A formats to convert to so the output meets Factur-X's PDF/A-3 requirement. It returns pdfFormats unchanged when Fac