AlphanumericSort implements sort.Interface and helps to sort strings alphanumerically by either a numeric prefix or, if missing, a numeric suffix. Se

Api helps to interact with Chromium for converting HTML documents to PDF.

Api is a module that provides an HTTP server. Other modules may add routes, middlewares or health checks.

Api is a module that provides a [Uno] to interact with LibreOffice.

ApiMock is a mock for the [Api] interface.

ApiMock is a mock for the [Uno] interface.

App is a module interface for modules which can be started or stopped by the application.

AsynchronousCounter is a module interface that returns the number of active asynchronous requests. See https://github.com/gotenberg/gotenberg/issues/

Bookmark represents a node in the PDF document's outline (table of contents).

Chromium is a module that provides both an [Api] and routes for converting an HTML document to PDF.

Cmd wraps an [exec.Cmd].

Context is a struct that helps to initialize modules. When provisioning, a module may use the context to get other modules that it needs internally.

Context is the request context for a "multipart/form-data" request.

ContextMock is a helper for tests. ctx := &api.ContextMock{Context: &api.Context{}}

Cookie gathers the available entries for setting a cookie in the Chromium cookies' jar.

DebugInfo gathers data for debugging.

Debuggable is a module interface for modules which want to provide additional debug data.

DecideOption customizes how [DecideOutbound] and [FilterOutboundURL] validate a URL. Options are applied in order on top of the permissive defaults (n

EmulatedMediaFeature gathers the available entries for emulating a media feature.

EncryptOptions gathers the parameters for encrypting a PDF. An empty UserPassword with a set OwnerPassword produces an owner-only document: it opens w

ExifTool abstracts the CLI tool ExifTool and implements the [gotenberg.PdfEngine] interface.

ExtraHttpHeader are extra HTTP headers to send by Chromium.

FacturX gathers the properties required by the Factur-X/ZUGFeRD standard for the document-level XMP metadata packet of a PDF/A-3.

FileSystem provides utilities for managing temporary directories. It creates unique directory names based on UUIDs to ensure isolation of temporary fi

FormData is a helper for validating and hydrating values from a "multipart/form-data" request. form := ctx.FormData()

HealthChecker is a module interface that allows adding health checks to the API. See https://github.com/alexliesenfeld/health for more details.

HealthCheckerMock is a mock for the [HealthChecker] interface.

Credits: https://www.joeshaw.org/error-handling-in-go-http-applications. HttpError is an interface allowing to retrieve the HTTP details of an error.

LeveledLogger is a wrapper around a [slog.Logger] so that it may be used by a [retryablehttp.Client].

LibreOffice is a module that provides a route for converting documents to PDF with LibreOffice.

LibreOfficePdfEngine interacts with the LibreOffice (Universal Network Objects) API and implements the [gotenberg.PdfEngine] interface.

Metric represents a unitary metric.

MetricsProvider is a module interface which provides a list of [Metric]. func (m *YourModule) Provision(ctx *gotenberg.Context) error { provider,

MetricsProviderMock is a mock for the [MetricsProvider] interface.

Middleware is a middleware that can be added to the [Api]'s middlewares chain. middleware := Middleware{ Handler: func() echo.MiddlewareFunc {

MiddlewarePriority is a type that helps to determine the execution order of middlewares provided by the [MiddlewareProvider] modules in a stack.

MiddlewareProvider is a module interface that adds middlewares to the [Api].

MiddlewareProviderMock is a mock for the [MiddlewareProvider] interface.

MiddlewareStack is a type that helps to determine in which stack the middlewares provided by the [MiddlewareProvider] modules should be located.

MkdirAll defines the method signature for create a directory. Implement this interface if you don't want to rely on [os.MkdirAll], notably for testing

MkdirAllMock is a mock for the [MkdirAll] interface.

Module is a sort of plugin which adds new functionalities to the application or other modules. type YourModule struct { property string } func

ModuleDescriptor describes your module for the application.

ModuleMock is a mock for the [Module] interface.

Options are the common options for all conversions.

Options gathers available options when converting a document to PDF. See: https://help.libreoffice.org/latest/en-US/text/shared/guide/pdf_params.html.

OsMkdirAll implements the [MkdirAll] interface with [os.MkdirAll].

OsPathRename implements the [PathRename] interface with [os.Rename].

OutboundDecision is the result of validating an outbound URL via [DecideOutbound]. Callers use it to dial the destination either directly (operator-ap

ParsedFlags wraps a [flag.FlagSet] so that retrieving the typed values is easier.

PathRename defines the method signature for renaming files. Implement this interface if you don't want to rely on [os.Rename], notably for testing pur

PathRenameMock is a mock for the [PathRename] interface.

PdfCpu abstracts the CLI tool pdfcpu and implements the [gotenberg.PdfEngine] interface.

PdfEngine provides an interface for operations on PDFs. Implementations can use various tools like PDFtk, or implement functionality directly in Go.

PdfEngineInvalidArgsError represents an error returned by a PDF engine when invalid arguments are provided. It includes the name of the engine and a d

PdfEngineMock is a mock for the [PdfEngine] interface. nolint:dupl

PdfEngineProvider offers an interface to instantiate a [PdfEngine]. This is used to decouple the creation of a [PdfEngine] from its consumers. Exampl

PdfEngineProviderMock is a mock for the [PdfEngineProvider] interface.

PdfEngines acts as an aggregator and manager for multiple PDF engine modules. It enables the selection and ordering of PDF engines based on user prefe

PdfFormats specifies the target formats for a PDF conversion.

PdfOptions are the available options for converting an HTML document to PDF.

PdfPermissions gathers the document permissions enforced when a PDF is encrypted. Each field defaults to true (the action is allowed); set a field to

PdfTk abstracts the CLI tool PDFtk and implements the [gotenberg.PdfEngine] interface.

Process is an interface that represents an abstract process and provides methods for starting, stopping, and checking the health of the process. Impl

ProcessMock is a mock for the [Process] interface.

ProcessSupervisor provides methods to manage a [Process], including starting, stopping, and ensuring its health. Additionally, it allows for the exec

ProcessSupervisorMock is a mock for the [ProcessSupervisor] interface.

Prometheus is a module that collects metrics and exposes them via an HTTP route.

Provider is a module interface that exposes a method for creating an [Api] for other modules. func (m *YourModule) Provision(ctx *gotenberg.Context)

Provider is a module interface that exposes a method for creating a [Uno] for other modules. func (m *YourModule) Provision(ctx *gotenberg.Context)

ProviderMock is a mock for the [Provider] interface.

Provisioner is a module interface for modules which have to be initialized according to flags, environment variables, the context, etc.

ProvisionerMock is a mock for the [Provisioner] interface.

QPdf abstracts the CLI tool QPDF and implements the [gotenberg.PdfEngine] interface.

Route represents a route from a [Router].

Router is a module interface that adds routes to the [Api].

RouterMock is a mock for the [Router] interface.

ScreenshotOptions are the available options for capturing a screenshot from an HTML document.

SentinelHttpError is the HTTP sidekick of an error.

SplitMode gathers the data required to split a PDF into multiple parts.

Stamp gathers the data required to apply a watermark or stamp to a PDF.

SystemLogger is a module interface for modules which want to display messages on startup.

TelemetryConfig gathers the configuration data for Gotenberg's telemetry.

Uno is an abstraction on top of the Universal Network Objects API.

Validator is a module interface for modules which have to be validated after provisioning.

ValidatorMock is a mock for the [Validator] interface.

Webhook is a module that provides a middleware for uploading output files to any destinations in an asynchronous fashion.