Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Index your code
hub
/
github.com/gotenberg/gotenberg
/ functions
Functions
1,037 in github.com/gotenberg/gotenberg
⨍
Functions
1,037
◇
Types & classes
147
↓ 2 callers
Function
pipeAndClose
pipeAndClose copies bytes from src to dst and closes both ends when the copy finishes.
pkg/modules/libreoffice/api/proxy.go:226
↓ 2 callers
Function
printToPdfAttrs
printToPdfAttrs derives bounded, low-cardinality attributes from the print options. Raw header/footer templates and page ranges are reduced to boolean
pkg/modules/chromium/tasks.go:146
↓ 2 callers
Function
qpdfPermissionArgs
Encrypt adds password protection to a PDF file using QPDF. qpdfPermissionArgs maps PDF permissions to QPDF --encrypt restriction flags. It returns nil
pkg/modules/qpdf/qpdf.go:332
↓ 2 callers
Method
read
(p []byte)
pkg/modules/chromium/stream.go:100
↓ 2 callers
Method
readFile
readFile binds the content of a file to a string variable. It populates an error if it fails to read the file content.
pkg/modules/api/formdata.go:673
↓ 2 callers
Method
recentlyHealthy
recentlyHealthy reports whether a successful probe landed within [healthCheckCacheTTL]. Negative results are never cached so recovery from a real outa
pkg/gotenberg/supervisor.go:277
↓ 2 callers
Method
recordNetwork
recordNetwork lifts per-conversion network aggregates onto the span and the network metrics. Counts are dimensioned by outcome and bytes feed a histog
pkg/modules/chromium/chromium.go:1021
↓ 2 callers
Function
rejectFileScheme
rejectFileScheme returns an HTTP 400 [api] error when rawURL uses the file:// scheme. /forms/chromium/convert/url and forms/chromium/screenshot/url ac
pkg/modules/chromium/routes.go:417
↓ 2 callers
Function
removeHopByHopHeaders
(h http.Header)
pkg/modules/libreoffice/api/proxy.go:328
↓ 2 callers
Method
scheme
(https bool)
pkg/gotenberg/semconv/server.go:297
↓ 2 callers
Method
send
send call the webhook either to send the success response or the error response.
pkg/modules/webhook/client.go:39
↓ 2 callers
Method
sendEvent
sendEvent sends a structured JSON event to the events URL. It is fire-and-forget: failures are logged but do not propagate.
pkg/modules/webhook/client.go:157
↓ 2 callers
Function
setCookiesActionFunc
(logger *slog.Logger, cookies []Cookie)
pkg/modules/chromium/tasks.go:281
↓ 2 callers
Method
slogLevel
()
pkg/gotenberg/telemetry.go:49
↓ 2 callers
Function
sofficeProxyEnv
sofficeProxyEnv overlays http_proxy/https_proxy on env so soffice's libcurl path also routes through proxyAddr. The environment variables supplement t
pkg/modules/libreoffice/api/proxy.go:306
↓ 2 callers
Method
spanAttrs
spanAttrs returns the client-span attributes for a Chromium invocation: the server address and the Chromium version, plus any extra attributes. The ve
pkg/modules/chromium/chromium.go:756
↓ 2 callers
Function
startGotenbergContainer
(ctx context.Context, env map[string]string)
test/integration/scenario/containers.go:102
↓ 2 callers
Method
stopIdleTicker
stopIdleTicker signals the idle ticker goroutine to exit, if one is running.
pkg/gotenberg/supervisor.go:394
↓ 2 callers
Function
stripHopByHopHeaders
(h http.Header)
pkg/modules/chromium/pinning_proxy.go:336
↓ 2 callers
Function
stripQpdfStringPrefix
stripQpdfStringPrefix removes the type prefix that QPDF adds to JSON string values. Known prefixes: "u:" (Unicode), "b:" (binary), "e:" (encoded).
pkg/modules/qpdf/qpdf.go:700
↓ 2 callers
Function
sumInt64Counter
(rm metricdata.ResourceMetrics, name string)
pkg/modules/libreoffice/api/core_dumped_test.go:16
↓ 2 callers
Method
tracedLaunch
tracedLaunch wraps a process (re)start in an <engine>.process.start span, tagged with the reason that triggered it. The eager restart after the maximu
pkg/gotenberg/supervisor.go:500
↓ 2 callers
Function
userAgentOverride
(logger *slog.Logger, userAgent string)
pkg/modules/chromium/tasks.go:330
↓ 2 callers
Function
validateFacturX
validateFacturX checks the Factur-X fields against the supported values.
pkg/modules/qpdf/qpdf.go:868
↓ 2 callers
Function
waitDelayBeforePrintActionFunc
(logger *slog.Logger, disableJavaScript bool, delay time.Duration)
pkg/modules/chromium/tasks.go:526
↓ 2 callers
Function
waitForExpressionBeforePrintActionFunc
(logger *slog.Logger, disableJavaScript bool, expression string)
pkg/modules/chromium/tasks.go:551
↓ 2 callers
Function
waitForSelectorVisibleBeforePrintActionFunc
(logger *slog.Logger, selector string)
pkg/modules/chromium/tasks.go:593
↓ 2 callers
Method
writeAndApplyUpdate
writeAndApplyUpdate marshals the update objects as QPDF JSON v2, writes them to a temp file, and applies the update via --update-from-json. extraArgs
pkg/modules/qpdf/qpdf.go:601
↓ 1 callers
Method
AsyncCount
()
pkg/modules/api/api.go:180
↓ 1 callers
Method
Checks
()
pkg/modules/api/api.go:171
↓ 1 callers
Method
Debug
()
pkg/gotenberg/modules.go:81
↓ 1 callers
Function
DefaultOptions
DefaultOptions returns the default values for Options.
pkg/modules/libreoffice/api/api.go:254
↓ 1 callers
Function
DefaultScreenshotOptions
DefaultScreenshotOptions returns the default values for ScreenshotOptions.
pkg/modules/chromium/chromium.go:366
↓ 1 callers
Method
EmbedsMetadata
EmbedsMetadata parses the "embedsMetadata" form field (a JSON string) into a map keyed by filename. Each value is a map of property names to values (e
pkg/modules/api/formdata.go:406
↓ 1 callers
Method
Enabled
(_ context.Context, _ slog.Level)
pkg/modules/chromium/pinning_proxy_test.go:33
↓ 1 callers
Method
ErrorType
(err error)
pkg/gotenberg/semconv/client.go:171
↓ 1 callers
Method
Extensions
()
pkg/modules/libreoffice/api/api.go:310
↓ 1 callers
Function
FailedScenarioPaths
FailedScenarioPaths returns file:line paths of failed scenarios.
test/integration/scenario/scenario.go:39
↓ 1 callers
Function
FanOut
(handlers ...slog.Handler)
pkg/gotenberg/internal/log/handler.go:107
↓ 1 callers
Function
FilterDeadline
FilterDeadline checks if the given value is allowed and not denied according to regex patterns. The allowed list uses OR semantics (value must match a
pkg/gotenberg/filter.go:20
↓ 1 callers
Method
Info
Info logs a message at the info level using the wrapped slog.Logger.
pkg/gotenberg/telemetry.go:241
↓ 1 callers
Function
InitLogger
InitLogger initializes the global logger.
pkg/gotenberg/internal/log/log.go:9
↓ 1 callers
Function
InitTracerProvider
InitTracerProvider initializes the OpenTelemetry tracer provider.
pkg/gotenberg/internal/otel/otel.go:68
↓ 1 callers
Function
InjectFacturXXMPStub
InjectFacturXXMPStub injects Factur-X XMP metadata into PDF files. If the Factur-X data is not set, it does nothing.
pkg/modules/pdfengines/routes.go:655
↓ 1 callers
Method
Launch
()
pkg/gotenberg/supervisor.go:171
↓ 1 callers
Function
LevelFilter
(next slog.Handler, level slog.Level)
pkg/gotenberg/internal/log/handler.go:153
↓ 1 callers
Function
Logger
Logger returns the global logger.
pkg/gotenberg/internal/log/log.go:26
↓ 1 callers
Method
LookupNetIP
(ctx context.Context, network, host string)
pkg/gotenberg/outbound.go:34
↓ 1 callers
Method
MandatoryBool
MandatoryBool binds a form field to a bool variable. It populates an error if the value is not bool, is empty, or the "key" does not exist. var foo
pkg/modules/api/formdata.go:102
↓ 1 callers
Method
MandatoryContent
MandatoryContent binds the content of a form data file to a string variable. It populates an error if the file does not exist. var content string
pkg/modules/api/formdata.go:358
↓ 1 callers
Method
MandatoryDuration
MandatoryDuration binds a form field to a time.Duration variable. It populates an error if the value is not time.Duration, or is empty, or the "key" d
pkg/modules/api/formdata.go:163
↓ 1 callers
Method
MandatoryFloat64
MandatoryFloat64 binds a form field to a float64 variable. It populates an error if the value is not float64, is empty, or the "key" does not exist.
pkg/modules/api/formdata.go:142
↓ 1 callers
Method
MandatoryInches
MandatoryInches binds a form field to a float64 variable. It populates an error if the value cannot be computed back to inches, is empty, or the "key"
pkg/modules/api/formdata.go:188
↓ 1 callers
Method
MandatoryInt
MandatoryInt binds a form field to an int variable. It populates an error if the value is not int, or is empty, or the "key" does not exist. var foo
pkg/modules/api/formdata.go:122
↓ 1 callers
Function
MergeStub
MergeStub merges given PDFs. If only one input PDF, it does nothing and returns the corresponding input path.
pkg/modules/pdfengines/routes.go:258
↓ 1 callers
Method
MetricAttributes
(req *http.Request, statusCode int, additionalAttributes []attribute.KeyValue)
pkg/gotenberg/semconv/client.go:203
↓ 1 callers
Method
MetricOptions
(ma MetricAttributes)
pkg/gotenberg/semconv/client.go:271
↓ 1 callers
Method
Metrics
()
pkg/gotenberg/metrics.go:25
↓ 1 callers
Method
Middlewares
()
pkg/modules/api/api.go:99
↓ 1 callers
Method
MustDeprecatedDuration
MustDeprecatedDuration returns the time.Duration value of a deprecated flag if it was explicitly set or the time.Duration value of the new flag. It pa
pkg/gotenberg/flags.go:163
↓ 1 callers
Method
MustDeprecatedFloat64
MustDeprecatedFloat64 returns the float value of a deprecated flag if it was explicitly set or the float value of the new flag. It panics if an error
pkg/gotenberg/flags.go:141
↓ 1 callers
Method
MustDeprecatedHumanReadableBytes
MustDeprecatedHumanReadableBytes returns the human-readable bytes of a deprecated flag if it was explicitly set or the human-readable bytes string of
pkg/gotenberg/flags.go:196
↓ 1 callers
Method
MustDeprecatedInt
MustDeprecatedInt returns the int value of a deprecated flag if it was explicitly set or the int value of the new flag. It panics if an error occurs.
pkg/gotenberg/flags.go:119
↓ 1 callers
Method
MustDeprecatedInt64
MustDeprecatedInt64 returns the int64 value of a deprecated flag if it was explicitly set or the int64 value of the new flag. It panics if an error oc
pkg/gotenberg/flags.go:97
↓ 1 callers
Method
MustDeprecatedRegexp
MustDeprecatedRegexp returns the regular expression of a deprecated flag if it was explicitly set or the regular expression of the new flag. It panics
pkg/gotenberg/flags.go:218
↓ 1 callers
Method
MustDeprecatedStringSlice
MustDeprecatedStringSlice returns the string slice value of a deprecated flag if it was explicitly set or the string slice value of the new flag. It p
pkg/gotenberg/flags.go:53
↓ 1 callers
Function
NewGotenbergHandler
(next slog.Handler, prefix string)
pkg/gotenberg/internal/log/handler.go:15
↓ 1 callers
Method
Path
Path binds the absolute path of a form data file to a string variable. var path string ctx.FormData().Path("foo.txt", &path)
pkg/modules/api/formdata.go:320
↓ 1 callers
Method
Paths
Paths bind the absolute paths of form data files, according to a list of file extensions, to a string slice variable. var paths []string ctx.FormD
pkg/modules/api/formdata.go:375
↓ 1 callers
Method
Pdf
(ctx context.Context, logger *slog.Logger, url, outputPath string, options PdfOptions)
pkg/modules/chromium/chromium.go:429
↓ 1 callers
Method
Pdf
Pdf converts a document to PDF.
pkg/modules/libreoffice/api/api.go:659
↓ 1 callers
Method
PdfEngine
PdfEngine returns a [gotenberg.PdfEngine].
pkg/modules/pdfengines/pdfengines.go:293
↓ 1 callers
Method
Printf
(format string, v ...any)
test/integration/scenario/containers.go:57
↓ 1 callers
Method
Provision
(*Context)
pkg/gotenberg/modules.go:53
↓ 1 callers
Function
PruneOrphanedNetworks
PruneOrphanedNetworks removes dangling networks created by the test suite. Each scenario spins a dedicated network, and a failed container start can l
test/integration/scenario/containers.go:32
↓ 1 callers
Method
ReadMetadata
ReadMetadata extracts the metadata of a given PDF file by invoking the exiftool binary with "-j" (JSON output) and parsing the result.
pkg/modules/exiftool/exiftool.go:301
↓ 1 callers
Method
RegisterDiskPath
RegisterDiskPath associates a disk path with an original filename so that [Context.OriginalFilename] can resolve it later.
pkg/modules/api/context.go:555
↓ 1 callers
Method
RequestTraceAttrs
RequestTraceAttrs returns trace attributes for an HTTP request made by a client.
pkg/gotenberg/semconv/client.go:62
↓ 1 callers
Function
ResetFailedScenarios
ResetFailedScenarios clears the collected failures.
test/integration/scenario/scenario.go:32
↓ 1 callers
Method
ResponseTraceAttrs
ResponseTraceAttrs returns trace attributes for an HTTP response made by a client.
pkg/gotenberg/semconv/client.go:144
↓ 1 callers
Method
RoundTrip
RoundTrip validates req.URL and delegates to the base transport.
pkg/gotenberg/outbound.go:366
↓ 1 callers
Method
Routes
()
pkg/modules/api/api.go:70
↓ 1 callers
Method
Screenshot
(ctx context.Context, logger *slog.Logger, url, outputPath string, options ScreenshotOptions)
pkg/modules/chromium/chromium.go:430
↓ 1 callers
Method
Shutdown
()
pkg/gotenberg/supervisor.go:190
↓ 1 callers
Method
Start
Start starts the command but does not wait for its completion.
pkg/gotenberg/cmd.go:72
↓ 1 callers
Function
StartTelemetry
StartTelemetry starts the telemetry utilities.
pkg/gotenberg/telemetry.go:108
↓ 1 callers
Method
StartupMessage
StartupMessage returns a custom message to display on startup. If it returns an empty string, a default startup message is used instead.
pkg/gotenberg/modules.go:68
↓ 1 callers
Method
SystemMessages
()
pkg/gotenberg/modules.go:75
↓ 1 callers
Method
Validate
Validate validates the telemetry configuration.
pkg/gotenberg/telemetry.go:59
↓ 1 callers
Method
WorkingDirPath
WorkingDirPath constructs and returns the full path to the working directory inside the system's temporary directory.
pkg/gotenberg/fs.go:64
↓ 1 callers
Method
acquireSlot
acquireSlot attempts to acquire a semaphore slot, yielding it back if a restart drain is in progress.
pkg/gotenberg/supervisor.go:451
↓ 1 callers
Function
applyDefaultEnv
applyDefaultEnv merges baseline environment variables that the integration tests rely on into env, without overwriting values supplied by the test sce
test/integration/scenario/containers.go:85
↓ 1 callers
Function
basicAuthMiddleware
basicAuthMiddleware manages basic authentication.
pkg/modules/api/middlewares.go:320
↓ 1 callers
Function
captureScreenshotActionFunc
(logger *slog.Logger, outputPath string, options ScreenshotOptions)
pkg/modules/chromium/tasks.go:162
↓ 1 callers
Function
contextMiddleware
contextMiddleware, middleware for "multipart/form-data" requests, sets the [Context] and related context.CancelFunc in the [echo.Context] under "conte
pkg/modules/api/middlewares.go:337
↓ 1 callers
Function
convertHtmlRoute
convertHtmlRoute returns an [api.Route] which can convert an HTML file to PDF.
pkg/modules/chromium/routes.go:527
↓ 1 callers
Function
convertMarkdownRoute
convertMarkdownRoute returns an [api.Route] which can convert markdown files to PDF.
pkg/modules/chromium/routes.go:610
↓ 1 callers
Function
convertRoute
convertRoute returns an [api.Route] which can convert PDFs to a specific ODF format.
pkg/modules/pdfengines/routes.go:1265
↓ 1 callers
Function
convertRoute
convertRoute returns an [api.Route] which can convert LibreOffice documents to PDF.
pkg/modules/libreoffice/routes.go:20
↓ 1 callers
Function
convertUrlRoute
convertUrlRoute returns an [api.Route] which can convert a URL to PDF.
pkg/modules/chromium/routes.go:438
← previous
next →
301–400 of 1,037, ranked by callers