The server element defines settings for the server such as the ports, user sources or authorization settings. Some of these changes might require a server restart to take effect.
Defines the host name and context path of the server.
Defines the port and command for server shutdown commands.
Defines a series of connectors that the server listens to. These can provide encrypted or unencrypted access to the server.
Defines a single connector on which the server listens to. This can be an encrypted or unencrypted connector.
Sets the user store settings for the server. This source is used for user authentication when the server issues authorization tokens.
Configures an APR Lifecycle Listener for the underlying tomcat server.
Defines the access information for the server's truststore, which contains all third-party certificates that the server should trust. This applies to connections that the server establishes to external servers, such as HTTP SSL connections or LDAPS connections.
The password required to access the truststore.
The name (without path) of the JKS keystore file (in the "keystore/" folder) that is to serve as the server's truststore.
Defines the local authorization provider that authenticates users and provides authorization tokens for API access.
Defines settings for external OAuth2 providers that issue authorization tokens to clients required for API access. The settings are necessary to validate the validity of the tokens by the server.
Configures health endpoint management settings.
If this element is absent, all management operations on health endpoints are disabled (fail-closed).
A connector defines the properties of a port the server can be accessed by.
Defines proxy configuration for the connector.
Defines the settings for a TLS connector.
When set to true this connector is active and may be used to connect to the server.
The IP address to which the connector should bind. If not defined, all IP addresses are used.
The port the connector is listening to.
Specifies whether to apply GZIP compression to the message to save bandwidth.
Sets the minimum number of bytes a message must reach before GZIP compression shall be applied.
Selects the MIME Types of message contents, that may be compressed via GZIP compression.
The protocol to use for the connector.
Defines the settings for a TLS connector.
Defines the keystore with the private server key and the certificate used to encrypt the connection. This keystore may only contain exactly one certificate or certificate chain with one private key.
The alias used for the private server key and certificate in the keystore. Can be empty if the keystore only contains a single certificate.
Defines the keystore containing the trusted certificates (truststore).
Lists the protocols, that are accepted by the TLS connector.
Selects the TLS protocols for the connector.
Selects encryption algorithms (ciphers) used by the TLS connector.
Selects a cipher that shall be supported.
When set to true, this forces the client to honor the TLS connector's cipher preference order. Otherwise, the client can select any cipher from the list itself.
The maximum number of request processing threads created by this connector.
The TLS connection scheme. (e.g. "https")
Whether a client must provide a valid certificate before being accepted by the connector.
The time in seconds before a session is encountering its timeout.
The number of SSL sessions to maintain in the session cache.
Defines the host name and context path of the server.
A valve element represents a component to insert into the request processing pipeline of the underlying Tomcat server.
(See: https://tomcat.apache.org/tomcat-10.1-doc/config/valve.html for further information.)
A filter element represents a component to insert into the request processing pipeline of the underlying Tomcat server.
(See: https://tomcat.apache.org/tomcat-10.1-doc/config/filter.html for further information.)
The csp element allows you to set a content security policy (https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP) for the server portal page.
Sets the host name part of the server address (e.g. http://localhost).
Sets the context path of the server address for the portal and the web services (e.g., http://localhost/webPDF).
Defines the port and command for the server shutdown.
The port that shall listen for shutdown commands.
The command that shall be listened for.
When set to true, the server will restart upon the shutdown's completion. Otherwise, the server will be stopped after the command.
Defines a certificate keystore.
The format of the keystore file containing the certificate (or certificate chain) and private key (optionally encrypted) to be used for SSL encryption.
The password required to access the keystore.
The name of the keystore file to use.
Defines proxy configuration for the connector.
The protocol scheme for the proxy (e.g. "http" or "https").
The proxy host's name.
The port on which the proxy listens.".
Defines settings for the server's user storage.
Defines a relational user database as a user source.
Defines an LDAP dictionary or Active Directory as a user source.
Defines the local XML file "conf/users.xml" as the user source. The users are managed locally via the portal administration area.
Defines an Azure Active Directory as a user source.
Sets the name of the group that grants administrative rights to users. This allows replacing the default value "admin" with a user-defined group name. A user must be a member of the group to be granted administrative rights.
Sets the name of the group that grants normal user rights to users. This allows replacing the default "user" value with a custom group name. A user must be a member of the group to be granted normal user rights.
Defines a relational user database as a user source.
The name of the driver (path of the java class) to use for database access. (e.g. "com.mysql.jdbc.Driver".)
The URL of the database. (e.g. "jdbc:mysql://localhost:3306/webpdf".)
The name of the database table, that lists the server's users.
The name of the column containing the user's name.
The name of the column containing the user's credentials.
The name of the table that defines the available user roles.
The name of the column containing the user's role.
The name of the database user to access the database for.
The password of the database user to access the database with.
This field currently is unused.
Defines an LDAP dictionary or Active Directory as a user source.
The URL used to connect to the LDAP server. (e.g. "ldap://server.example.com:389/".)
The name of the user used to access the LDAP server. (e.g. "cn=ldapuser,cn=Users,dc=example,dc=local".)
The password used to access the LDAP server.
The Base for the LDAP user search. (e.g. "CN=Users,DC=example,DC=local".)
The LDAP request used to find the user's login name with. (e.g. "(sAMAccountName={0})".)
The Base for the LDAP user's role determination. (e.g. "CN=Users,DC=example,DC=local".)
The LDAP request used to find the user's role with. (e.g. "(member={0})".)
The field that indicates that a user is part of a group. (e.g. "cn".)
When set to true, all LDAP requests that respond with references are followed. The same schema and credentials are used for the referred request.
Specifies the mode for handling the certificates presented by the LDAP server when establishing a connection.
Defines an Azure Active Directory as a user source.
Defines the local XML file "conf/users.xml" as the user source. The users are managed locally via the portal administration area.
Configures an APR Lifecycle Listener for the underlying tomcat server.
When set to true, the APR Lifecycle Listener shall be activated.
This field currently is unused.
Selects the SSL engine to use, possible values are "off" (do not use SSL) "on" (use SSL without specifying the engine).
An entropy source to seed the SSL engine's random number generation with. To allow for quicker start time, set this to "/dev/urandom".
Set this to "on" to request SSL to operate in FIPS (Federal Information Processing Standards) mode.
For this to take effect "useOpenSSL" must be set to true. (It is highly recommended to refer to https://tomcat.apache.org/tomcat-10.0-doc/config/listeners.html)
When set to true this activates the usage of OpenSSL for NIO and NIO2 connectors.
Sets the TLS protocol type for SSL connections.
Specifies the encryption algorithm (cipher) for TLS (SSL) connections.
Specifies whether to apply GZIP compression to the message to save bandwidth.
Defines the location of the user's certificate stored in the Active Directory.
When set to true a user certificate can be found in the Active Directory.
The name of the attribute selecting the user's certificate.
Defines the location of the user's keystore stored in the active directory.
When set to true a user keystore can be found in the Active Directory.
The name of the attribute selecting the user's keystore.
When these settings are present, the server sends a ping to the configured LDAP server to keep the connection alive.
When set to true the server sends a ping to the configured LDAP server to keep the connection alive.
The sending interval in seconds at which the ping is sent.
The protocol to use for the connector.
Defines settings for external OAuth2 providers that issue authorization tokens to clients required for API access. The settings are necessary to validate the validity of the tokens by the server.
Defines the external providers that should issue OAuth2 tokens and be verifiable by the server.
Defines an Oauth2 authorization provider.
Specifies the settings required to perform an OAuth2 logout.
Selects the OAuth2 provider or "generic" when not available in the list.
The displayed name for the provider (e.g., in the portal).
Selects the OAuth2 flow used. Depending on the flow, different settings are necessary for the provider.
Sets a unique ID that uniquely identifies this provider configuration.
Sets the OAuth2 client identifier.
Sets a tenant identifier for the OAuth2 request. Not all providers require a tenant id.
Sets the discovery URL for the OAuth2 process, where the server can find, for example, the required public signature keys for token validation.
Sets the application identifier that uniquely identifies the application (the API of this server). This ID is also defined as the audience for the token to verify that the token was issued for the API dServer.
Specifies the scope for the OAuth2 token. Each separated by a space.
Sets the name of the claim (in most cases "roles") that contains the roles in the token.
Specifies the name of the claim (in most cases "sub") that contains the session ID in the token. This must be a unique identifier that uniquely identifies the authenticated client (or user).
Sets the name of the claim (in most cases "azp") that contains the client ID in the token.
Sets the name of the role that grants administrative rights. This allows changing the default "admin" value to a custom role name. This must match the content of the claim defined via "claimRoles".
Sets the name of the role that grants normal user rights. This allows changing the default "user" value to a custom role name. This must match the content of the claim defined via "claimRoles".
The maximum time skew that may occur between the local time on the server and the local time of the issuer of the token.
Specifies the settings required to perform an OAuth2 logout.
Sets the URL that will be called when an OAuth2 is executed. This URL can contain the variables
{redirectUrl}
and {clientId}, whose values are automatically inserted by the server.
Defines the settings for an OAuth2 provider that are required to validate the provider's tokens.
Defines the settings for an OAuth2 provider that are required to validate the provider's tokens.
Defines the local authorization provider that authenticates users and provides authorization tokens for API access.
Defines the settings for accessing the server's SOAP API (web services).
Defines the settings for accessing the server's REST API (web services).
If enabled, the local authorization provider is available to authenticate the user login and provide tokens for accessing the server API. If disabled, only external (e.g., OAuth) access tokens are allowed for API calls.
Defines the settings for accessing the server's SOAP API (web services).
If enabled, then the SOAP API is available.
If enabled, then anonymous logins (without a username and password) are allowed.
Defines the settings for accessing the server's REST API (web services).
Defines the setting for access tokens provided by the server.
Defines the setting for refresh tokens provided by the server.
Defines the restrictions and limits that apply when using the REST API and user sessions on the server.
If enabled, then the REST API is available.
If enabled, then anonymous logins (without a username and password) are allowed.
The maximum time skew that may occur between the local time of the client and the local time of the token issuer (the local server).
Defines the setting for access tokens provided by the server.
Number of seconds, before the token expires.
Defines the setting for refresh tokens provided by the server.
Number of seconds, before the token expires.
Defines the restrictions and limits that apply when using the REST API and user sessions on the server.
Sets the maximum size (in bytes) a file uploaded to the server may have (set to 0 to disable this limitation).
Sets the maximum size (in bytes) a file uploaded by a single user may have (set to 0 to disable this limitation).
Sets the maximum number of files that may be uploaded to the server (set to 0 to disable this limitation).
Sets the maximum number of files a single user may upload to the server (set to 0 to disable this limitation).
Sets the overall global disk space (in bytes) the server may use (set to 0 to disable this limitation).
Sets the maximum disk space (in bytes) a single user may use (set to 0 to disable this limitation).
Allows setting the configuration values for the "HTTP Connector" as described in the Tomcat manual.
Defines a single configuration setting via a name-value pair.
The Java class name of the valve implementation to use.
Further attributes to be set for the valve.
Defines a parameter for the filter that consists of a name and a
value
Defines the URL pattern assignment for the filter (e.g. "/*" for all URLs)
The Java class name of the filter implementation to use.
Defines a parameter for the filter that consists of a name and a
value
Defines the URL pattern assignment for the filter (e.g. "/*" for all URLs)
Configures health endpoint management settings.
If this element is absent, all management operations on health endpoints are disabled (fail-closed).
Configures Bearer Token authentication for the
POST /health/shutdown management endpoint
(Two-Phase Shutdown Phase 1).
The endpoint is only accessible when a token is configured.
If this element is absent or no token is set, the endpoint
returns 404 Not Found.
Configures Bearer Token authentication for the
POST /health/shutdown management endpoint
(Two-Phase Shutdown Phase 1).
The endpoint is activated by setting a non-empty token.
If no token is configured, the endpoint returns 404 Not Found.
Primary token source: XML attribute token.
Override via environment variable WEBPDF_HEALTH_SHUTDOWN_TOKEN
or system property webpdf.health.shutdown.token
(takes precedence over XML value).
The Bearer token required to access the
POST /health/shutdown endpoint.
Setting a non-empty token activates the endpoint.
Without a token the endpoint returns 404 Not Found.
Can be overridden via environment variable
WEBPDF_HEALTH_SHUTDOWN_TOKEN
or system property webpdf.health.shutdown.token.
Use a strong random token (e.g., 32+ characters) in production environments.
Defines the value for the HTTP header Content-Security-Policy.
Use ${nonce} to insert a nonce value from the server for the entry 'nonce-...'.
When set to true, the CSP is activated. The HTTP header "Content-Security-Policy" is added, and a "nonce" is added to the required resources.