# Pod Storage Service ESS' Pod Storage Service hosts the Pods created by the Pod provisioning service and is responsible for reading and writing the resources stored in the Pod. The Pod URL has the following pattern: ```none https://storage.{ESS Domain}/{Unique Root Container}/ ``` Prior to version 2.0, ESS Pods had the URL of the form **`https://{ESS Domain}/{username}/`** ## Pod Resources ESS Pods supports storing different types of Solid Resources, including [Containers](https://docs.inrupt.com/reference/glossary#container), [Resources](https://docs.inrupt.com/reference/glossary#non-rdf-resource), and [RDF Resources](https://docs.inrupt.com/reference/glossary#rdf-resource). ## Access For access to the Pod resources, ESS' Pod Storage service supports the use of the following tokens: * [UMA token](https://docs.inrupt.com/ess/2.5/services/service-uma) * [Solid-OpenID Connect (OIDC) access token](https://docs.inrupt.com/ess/2.5/services/service-oidc). See also: * [Pod Storage UMA Configuration](#pod-storage-uma-configuration) * [Solid-OIDC Issuer Configuration Options](#solid-oidc-issuer-configuration-options) ## Discovery ESS provides Pod storage service (and related) metadata at the following **`.well-known/solid`** URI: ``` https://storage.{ESS Domain}/.well-known/solid ``` Its [Response.body](https://developer.mozilla.org/en-US/docs/Web/API/Response/body) returns Resource Description Framework (RDF) statements. Depending on your configuration, the response can include information about: * List of applications that can perform read and write operations the [Access Control Resources](https://docs.inrupt.com/reference/glossary#access-control-resource) with the following caveat: {% hint style="warning" %} **Disambiguation**\ The list displays the value of [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage)'s [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](#inrupt_authorization_client_id_allow_list) configuration value, which is for discoverability purposes only. The actual configuration that determines which applications can access the ACR is the [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)'s [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_client_id_allow_list). As such, if the two lists are not in sync, the returned list from [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage) may not accurately reflect the trusted apps. {% endhint %} * Maximum number of Pods allowed per Agent. * Notification Gateway endpoint. * Provision service endpoint. * QPF service endpoint. ```none @prefix solid: . [ a solid:DiscoveryDocument ; ; solid:maxPodsPerOwner 10 ; solid:notificationGateway ; solid:provision ; solid:qpf ...`** , specify **`foobar.`** (including the dot **`.`** ) instead of, for example, **`foo`** or **`foobar`** . * If using converted form, if you want to match configuration properties of the form **`FOOBAR_...`** , specify **`FOOBAR_`** (including the underscore **`_`** ) instead of, for example, **`FOO`** or **`FOOBAR`** . {% endhint %} #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_DENY *Default* : **`inrupt.kafka`** A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow)) are not logged. That is, [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow). For example: * If **`foobar.`** is an allowed prefix, to suppress **`foobar.private.`** , you can specify **`foobar.private.`** to the deny list. * If **`foobar.`** is **not** an allowed prefix, no property starting with **`foobar.`** is logged. As such, you do not need to specify **`foobar.private`** to the deny list. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} **Warning** Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny) as well. {% endhint %} #### INRUPT\_STORAGE\_PRUNE\_ORPHAN\_BATCH\_SIZE An integer that limits the number of resource data identifiers selected by Prune during orphan data cleanup. {% hint style="warning" %} **Important** For [Prune cron job](#prune-cronjobs) that prunes soft-deleted resources, set to 0 . {% endhint %} An increase in the batch size may require a corresponding increase in [**`COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE`**](#com_inrupt_storage_metadata_jdbc_connectionlimiter_openconnection_timeout_value) . #### INRUPT\_STORAGE\_PRUNE\_PRUNABLE\_BATCH\_SIZE An integer that limits the number of results returned when querying the metadata. {% hint style="warning" %} **Important** For [Prune cron job](#prune-cronjobs) that prunes orphan data, set to 0 . {% endhint %} An increase in the batch size may require a corresponding increase in [**`COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE`**](#com_inrupt_storage_metadata_jdbc_connectionlimiter_openconnection_timeout_value) . #### INRUPT\_STORAGE\_PRUNE\_RETENTION\_WINDOW The minimum amount of time (specified in a format supported by Java Duration.parse() method; e.g., **`PT23H`** for 23 hours) that resources have been soft-deleted (marked as deleted) before they become eligible for pruning . That is, resources that have been soft-deleted for longer than the specified time can be selected for hard deletion by Prune ; i.e., these are "prunable" resources. This configuration does not affect the pruning of orphaned data. An increase in the retention window value may require a corresponding increase in [**`COM_INRUPT_STORAGE_METADATA_JDBC_CONNECTIONLIMITER_OPENCONNECTION_TIMEOUT_VALUE`**](#com_inrupt_storage_metadata_jdbc_connectionlimiter_openconnection_timeout_value) . To configure Prune, see [Modify Prune Configuration](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-pod-maintenance/modify-prune) ### Pod Storage Metrics Options #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_ALLOW *Default* : inrupt,quarkus.s3.aws.region A comma-separated list of configuration property prefixes (case-sensitive) that determine which configurations are logged: * If the list is empty, NO configuration property is logged. * If a configuration property starts with a listed prefix (case-sensitive), the configuration property and its value are logged unless the configuration also matches a prefix in [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) (which acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) list). As such, if the configuration matches prefix in both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1), the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) takes precedence and the configuration is not logged. For example, if inrupt. is an allow prefix, but inrupt.kafka. is a deny prefix, all configurations that start with inrupt.kafka. are excluded from the logs. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., inrupt.foobar.), or * using the MicroProfile Config environmental variables conversion value (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} **Warning** Use the same format for both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) as well. {% endhint %} {% hint style="info" %} **Tip** To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example: * If using dot-notation, if you want to match configuration properties of the form **`foobar....`** , specify **`foobar.`** (including the dot **`.`** ) instead of, for example, **`foo`** or **`foobar`** . * If using converted form, if you want to match configuration properties of the form **`FOOBAR_...`** , specify **`FOOBAR_`** (including the underscore **`_`** ) instead of, for example, **`FOO`** or **`FOOBAR`** . {% endhint %} #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_DENY *Default* : inrupt.kafka A comma-separated list of configuration name prefixes (case-sensitive) that determines which configurations (that would otherwise match the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1)) are not logged. That is, [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1). For example: * If **`foobar.`** is an allowed prefix, to suppress **`foobar.private.`** , you can specify **`foobar.private.`** to the deny list. * If **`foobar.`** is **not** an allowed prefix, no property starting with **`foobar.`** is logged. As such, you do not need to specify **`foobar.private`** to the deny list. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} **Warning** Use the same format for both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-1) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-1) as well. {% endhint %} ### Pod Storage Resource Read Auditing Option #### INRUPT\_STORAGE\_AUDIT\_RESOURCE\_READ\_ENABLED *Default* : **`false`** A boolean that determines whether to audit successful read resource events (i.e., successful (GET and HEAD operations on resources). Set to **`true`** to enable, and **`false`** to disable. {% hint style="warning" %} **Important** When auditing of read operations is enabled, the total number of Audit events may increase substantially. Before enabling read operations auditing, consider allocating more compute and network resources to ESS. {% endhint %} See also [Enable Resource Read Auditing](https://docs.inrupt.com/ess/installation/customize-configurations/customization-logging/manage-auditing#enable-resource-read-auditing) ### Pod Storage UMA Configuration #### INRUPT\_AUTHZ\_AS\_URI The URI of the UMA Authorization Server. The value must match: * [**`INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER`**](#inrupt_jwt_authorization_server_issuer) configuration for the service, and * [**`INRUPT_UMA_ISSUER`**](https://docs.inrupt.com/ess/2.5/service-uma#inrupt_uma_issuer) configuration for [UMA Service](https://docs.inrupt.com/ess/2.5/services/service-uma) #### INRUPT\_AUTHZ\_UMA\_ANONYMOUS\_ENABLED *Default* : **`false`** A boolean flag that determines whether to support anonymous (i.e., unauthenticated) access to resources that have been granted public access. {% hint style="warning" %} **Important** If set to **`true`** (i.e., allow unauthenticated access to resources that have been granted public access), update the service's Content-Security-Policy (default **`worker-src 'none'`** ) to include [Content-Security-Policy (CSP) sandbox](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/sandbox) , such as **`Content-Security-Policy: worker-src 'none'; sandbox allow-scripts`** . You can use [Quarkus HTTP configuration property](https://quarkus.io/guides/http-reference) to add the CSP header setting; namely **`QUARKUS_HTTP_HEADERS__CONTENT_SECURITY_POLICY__VALUE`** . {% endhint %} #### INRUPT\_AUTHZ\_UMA\_OIDC\_ENABLED *Default* : **`false`** A boolean flag that determines whether the Pod server supports OIDC access tokens. When set to **`false`** , clients will need access tokens from the associated UMA server. #### INRUPT\_JWT\_AUTHORIZATION\_SERVER\_ISSUER The URI of the UMA token issuer. The value must match [**`INRUPT_AUTHZ_AS_URI`**](#inrupt_authz_as_uri) . #### INRUPT\_JWT\_AUTHORIZATION\_SERVER\_JWKS The JWKS endpoint of the [**`INRUPT_JWT_AUTHORIZATION_SERVER_ISSUER`**](#inrupt_authz_as_uri). #### SMALLRYE\_JWT\_ENCRYPT\_KEY\_ID The key id of the JWK key used to encrypt the ticket for the UMA Authorization Server. Required if using UMA. #### SMALLRYE\_JWT\_ENCRYPT\_KEY\_LOCATION The location of the JWK key used to encrypt the ticket for the UMA Service. This should be configured to the [**`SMALLRYE_JWT_SIGN_KEY_LOCATION`**](https://docs.inrupt.com/ess/2.5/service-uma#smallrye_jwt_sign_key_location) on the [UMA Service](https://docs.inrupt.com/ess/2.5/services/service-uma) ### Pod Storage Options #### INRUPT\_AUTHORIZATION\_CLIENT\_ID\_ALLOW\_LIST Comma-delimited list of [Client IDs](https://docs.inrupt.com/reference/glossary#client-identifier) that are *displayed* in [**`/.well-known/solid`**](https://github.com/inrupt/docs-gitbook/blob/main/ess/2.5/services/appendix/discovery.md#well-known-solid) as the Client IDs of trusted applications. Trusted applications can perform read and write operations on the Access Control Resources. {% hint style="warning" %} **Disambiguation**\ Both [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization) and [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage) have an **`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`** setting. **Only** the [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization) setting affects which clients are allowed. The [Pod Storage Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-storage) is for [Discovery](#discovery) purposes only. {% endhint %} The list should reflect the values set in the [Authorization Service](https://docs.inrupt.com/ess/2.5/services/service-authorization)'s [**`INRUPT_AUTHORIZATION_CLIENT_ID_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-authorization#inrupt_authorization_client_id_allow_list) since the authorization server's configuration actually determines what clients are the trusted applications. That is, the Pod service's configuration is for discoverability purposes only. See [Set Authorization Client Allow List](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-security/modify-authz-client-list) #### INRUPT\_STORAGE\_HTTP\_BASE\_URL The base URL of the storage service. This is mainly for use by supporting services like Pod Provisioning service. {% hint style="warning" %} **Important** * The value requires a trailing slash **`/`** ; e.g., **`https://storage.{ESS_DOMAIN}/`** . * Ensure that Pod Storage Service's [**`INRUPT_STORAGE_HTTP_BASE_URL`**](#inrupt_storage_http_base_url) value is consistent with the [Pod Provision Service](https://docs.inrupt.com/ess/2.5/services/service-pod-management/service-pod-provision)'s [**`INRUPT_STORAGE_HTTP_BASE_URL`**](https://docs.inrupt.com/ess/2.5/services/service-pod-provision#inrupt_storage_http_base_url) value. {% endhint %} #### INRUPT\_STORAGE\_HTTP\_CACHE\_CONTROL\_MAX\_AGE *Default* : **`0`** The max-age directive value on the Cache-Control header. For more information of Cache-Control directives, see . ### Solid-OIDC Issuer Configuration Options #### INRUPT\_JWT\_ALLOWED\_SIGNATURE\_ALGORITHMS *Default* : **`ES256, RS256`** A comma-separated list that specifies the allowed encryption [algorithms](https://www.rfc-editor.org/rfc/rfc7515#section-4.1.1) used to sign ID tokens. #### INRUPT\_JWT\_ISSUER\_ALLOW\_LIST A comma-separated list of trusted issuers of Solid-OIDC tokens. * If unset, the service accepts Solid-OIDC tokens from all issuers with the exception of those in the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) . * If set, the service accepts only the Solid-OIDC tokens from the issuers in the list with the following exception: * If an issuer is in both [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) and [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) , the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) supersedes the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) and the issuer is not accepted by ESS. See also [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) . {% hint style="info" %} **Tip**\ Ensure that ESS UMA service' [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](https://docs.inrupt.com/ess/2.5/service-uma#inrupt_jwt_issuer_allow_list) is consistent with the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) value set for this service. {% endhint %} #### INRUPT\_JWT\_ISSUER\_DENY\_LIST A comma-separated list of disallowed issuers of Solid-OIDC tokens. * If unset, the service accepts Solid-OIDC tokens from all issuers unless [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) is set, in which case, the service only accepts tokens from those in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) . * If set, the service disallows the Solid-OIDC tokens from the issuers in the list. If [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) is also set, issuers not in the [**`INRUPT_JWT_ISSUER_ALLOW_LIST`**](#inrupt_jwt_issuer_deny_list) are also disallowed. {% hint style="info" %} **Tip**\ Ensure that ESS' UMA service's [**`INRUPT_JWT_ISSUER_DENY_LIST`**](https://docs.inrupt.com/ess/2.5/service-uma#inrupt_jwt_issuer_deny_list) is consistent with the [**`INRUPT_JWT_ISSUER_DENY_LIST`**](#inrupt_jwt_issuer_deny_list) value set for this service. {% endhint %} ### JSON-LD Context Configuration Options #### INRUPT\_JSONLD\_CONTEXT\_ALLOW\_LIST A comma-delimited list of trusted JSON-LD context URIs allowed to be dereferenced. #### INRUPT\_JSONLD\_CONTEXT\_DENY\_LIST A deny-list of JSON-LD context URIs. URIs listed in this configuration are prevented from being dereferenced. See also: [**`INRUPT_JSONLD_CONTEXT_ALLOW_LIST`**](#inrupt_jsonld_context_allow_list) . ### Logging Configuration #### QUARKUS\_LOG\_LEVEL *Default* : **`INFO`** Logging level. ### Kafka Configuration {% hint style="info" %} **Tip**\ See also [ESS’ Kafka Configuration](https://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration) {% endhint %} #### INRUPT\_KAFKA\_AUDITV1EVENTSENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsencrypted`** topic. #### INRUPT\_KAFKA\_AUDITV1EVENTSPRODUCERENCRYPTED\_CIPHER\_PASSWORD The strong cipher key to use when running auditing with encrypted messages over the **`auditv1eventsproducerencrypted`** topic. #### INRUPT\_KAFKA\_SOLIDRESOURCE\_CIPHER\_PASSWORD The symmetric key to use when encrypting messages (see [**`MP_MESSAGING_OUTGOING_SOLIDRESOURCE_VALUE_SERIALIZER`**](#mp_messaging_outgoing_solidresource_value_serializer) ). #### KAFKA\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers for use by ESS services, including this service. Setting [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) configures ESS to use the same Kafka instance(s) for all its Kafka [message channels](https://quarkus.io/guides/kafka#kafka-configuration) (e.g., **`solidresource`** and **`auditv1out`** message channels). The Pod management services use the **`solidresource`** and **`auditv1out`** message channels. {% hint style="info" %} **Note**\ Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . To use a different Kafka instance for the **`solidresource`** and **`auditv1out`** channels, use [**`MP_MESSAGING_OUTGOING_SOLIDRESOURCE_BOOTSTRAP_SERVERS`**](#mp_messaging_outgoing_solidresource_bootstrap_servers) and [**`MP_MESSAGING_OUTGOING_AUDITV1OUT_BOOTSTRAP_SERVERS`**](#mp_messaging_outgoing_auditv1out_bootstrap_servers) instead. {% endhint %} See also [ESS’ Kafka Configuration](https://docs.inrupt.com/ess/2.5/services/appendix/appendix-kafka-configuration) #### MP\_MESSAGING\_OUTGOING\_AUDITV1OUT\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers used for the outgoing audit v1 messages. These messages are sent over the **`auditv1out`** [message channel](https://quarkus.io/guides/kafka#kafka-configuration) . {% hint style="info" %} **Note**\ To configure ESS to use the same Kafka instances for all its Kafka message channels, use [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) option instead. Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . {% endhint %} #### MP\_MESSAGING\_OUTGOING\_SOLIDRESOURCE\_BOOTSTRAP\_SERVERS *Default* : **`localhost:9092`** Comma-delimited list of Kafka broker servers used for the outgoing resource notification messages. These messages are sent over the **`solidresource`** [message channel](https://quarkus.io/guides/kafka#kafka-configuration) . {% hint style="info" %} **Note**\ To configure ESS to use the same Kafka instances for all its Kafka message channels, use [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) option instead. Inrupt-provided overlays default to using [**`KAFKA_BOOTSTRAP_SERVERS`**](#kafka_bootstrap_servers) . {% endhint %} #### MP\_MESSAGING\_OUTGOING\_SOLIDRESOURCE\_VALUE\_SERIALIZER *Default* : **`org.apache.kafka.common.serialization.StringSerializer`** The serializer used for the notification messages the service sends to Kafka. Supported values are: * **`org.apache.kafka.common.serialization.StringSerializer`**When set to this value, notification messages sent to Kafka are unencrypted.\ Services that consume these messages (e.g., [WebSocket Notification Service](https://docs.inrupt.com/ess/2.5/services/service-notification/service-websocket)) will need to set their**`MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER`**to the corresponding deserializer value**`org.apache.kafka.common.serialization.StringDeserializer`**. * **`com.inrupt.components.kafka.encryption.EncryptMessageSerializer`**When set to this value, notification messages sent to Kafka are encrypted. Services that consume these encrypted messages (e.g., [WebSocket Notification Service](https://docs.inrupt.com/ess/2.5/services/service-notification/service-websocket)) will need to set their **`MP_MESSAGING_INCOMING_SOLIDRESOURCE_VALUE_DESERIALIZER`**configuration to the corresponding deserializer value **`com.inrupt.components.kafka.encryption.DecryptMessageDeserializer`**. ### AWS Options #### INRUPT\_STORAGE\_S3\_BUCKET\_NAME *Default* : **`inrupt.ess.storage`** The name of the S3 bucket used for storage. #### QUARKUS\_S3\_AWS\_CREDENTIALS\_STATIC\_PROVIDER\_ACCESS\_KEY\_ID AWS Access key id. #### QUARKUS\_S3\_AWS\_CREDENTIALS\_STATIC\_PROVIDER\_SECRET\_ACCESS\_KEY AWS Secret access key. #### QUARKUS\_S3\_AWS\_REGION An Amazon Web Services region that hosts the S3 Bucket. #### QUARKUS\_S3\_ENDPOINT\_OVERRIDE Override S3 endpoint URL. ### OpenTelemetry Options #### QUARKUS\_OTEL\_EXPORTER\_OTLP\_ENDPOINT The URL to which the OpenTelemetry exporter sends data. #### QUARKUS\_OTEL\_TRACES\_SAMPLER\_ARG *Default* : 0.0d A double compatible value between 0.0d and 1.0d to determine the sampling rate of the OpenTelemetry exporter. A value of 0.0d results in disabling OpenTelemetry exports. ### Configuration Logging ESS services log their startup configuration. #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_ALLOW *Default* : inrupt,smallrye.jwt.expiration.grace,mp.jwt.verify.clock.skew,smallrye.jwt.always-check-authorization,smallrye.jwt.token.decryption.kid,smallrye.jwt.token.schemes,smallrye.jwt.require.named-principal,smallrye.jwt.time-to-live,smallrye.jwt.jwks.refresh-interval,smallrye.jwt.jwks.forced-refresh-interval,smallrye.jwt.required.claims,mp.jwt.verify.audiences A comma-separated list of configuration property prefixes ( **case-sensitive** ) that determine which configurations are logged: * If the list is empty, **NO** configuration property is logged. * If a configuration property starts with a listed prefix ( **case-sensitive** ), the configuration property and its value are logged **unless** the configuration also matches a prefix in [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) (which acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) list). As such, if the configuration matches prefix in both [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) , the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) takes precedence and the configuration is not logged. For example, if **`inrupt.`** is an allow prefix, but **`inrupt.kafka.`** is a deny prefix, all configurations that start with **`inrupt.kafka.`** are excluded from the logs. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} **Warning** Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) as well. {% endhint %} {% hint style="info" %} **Tip** To avoid allowing more than desired configurations, specify as much of the prefix as possible. If the prefix specifies the complete prefix term, include the term delineator. For example: * If using dot-notation, if you want to match configuration properties of the form **`foobar....`** , specify **`foobar.`** (including the dot **`.`** ) instead of, for example, **`foo`** or **`foobar`** . * If using converted form, if you want to match configuration properties of the form **`FOOBAR_...`** , specify **`FOOBAR_`** (including the underscore **`_`** ) instead of, for example, **`FOO`** or **`FOOBAR`** . {% endhint %} #### INRUPT\_LOGGING\_CONFIGURATION\_PREFIX\_DENY *Default* : **`inrupt.kafka`** A comma-separated list of configuration name prefixes ( **case-sensitive** ) that determines which configurations (that would otherwise match the [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) ) are not logged. That is, [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) acts as a filter on [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) . For example: * If **`foobar.`** is an allowed prefix, to suppress **`foobar.private.`** , you can specify **`foobar.private.`** to the deny list. * If **`foobar.`** is **not** an allowed prefix, no property starting with **`foobar.`** is logged. As such, you do not need to specify **`foobar.private`** to the deny list. When specifying the prefixes, you can specify the prefixes using one of two formats: * using dot notation (e.g., **`inrupt.foobar.`** ), or * using the [MicroProfile Config environmental variables conversion value](https://quarkus.io/guides/config-reference#environment-variables) (e.g., **`INRUPT_FOOBAR_`** ). {% hint style="danger" %} **Warning** Use the same format for **both** [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) and [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) . For example, if you change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_ALLOW`**](#inrupt_logging_configuration_prefix_allow-2) , change the format of [**`INRUPT_LOGGING_CONFIGURATION_PREFIX_DENY`**](#inrupt_logging_configuration_prefix_deny-2) as well. {% endhint %} #### INRUPT\_STORAGE\_AUDIT\_RESOURCE\_READ\_ENABLED *Default* : **`false`** A boolean that determines whether to audit successful read resource events (i.e., successful (**`GET`** and **`HEAD`** operations on resources). Set to **`true`** to enable, and **`false`** to disable. {% hint style="warning" %} **Important** When auditing of read operations is enabled, the total number of Audit events may increase substantially. Before enabling read operations auditing, consider allocating more compute and network resources to ESS. {% endhint %} See also [Enable Resource Read Auditing](https://docs.inrupt.com/ess/installation/customize-configurations/customization-logging/manage-auditing#enable-resource-read-auditing) ### Logging Redaction #### INRUPT\_LOGGING\_REDACTION\_NAME\_ACTION *Default* : **`REPLACE`** Type of the redaction to perform. Supported values are:
ActionDescription
REPLACEDefault. Replaces the matching text with a specified replacement.
PLAINLeaves the matching field unprocessed. Only available if the redaction target is a field (i.e.,INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
DROPSuppresses the matching field. Only available if the redaction target is a field (i.e.,INRUPT_LOGGING_REDACTION_{NAME}_FIELD).
PRIORITIZEChanges the log level of the matching message.
SHA256Replaces the matching text with its hash.
* If the action is **`REPLACE`** ( *default* ), see also **`INRUPT_LOGGING_REDACTION_{NAME}_REPLACEMENT`** . * If the action is to **`PRIORITIZE`** , see also **`INRUPT_LOGGING_REDACTION_{NAME}_LEVEL`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### INRUPT\_LOGGING\_REDACTION\_NAME\_ENABLED *Default* : **`true`** A boolean that determines whether the redaction configurations with the specified **`INRUPT_LOGGING_REDACTION_{NAME}_`** prefix is enabled. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### INRUPT\_LOGGING\_REDACTION\_NAME\_EXCEPTION Fully qualified name of the exception class to match in the log messages (includes inner exception). Configure to target an exception message class. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### INRUPT\_LOGGING\_REDACTION\_NAME\_FIELD Exact name of the field to match in the log messages. Configure to target a specific log message field for redaction. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### INRUPT\_LOGGING\_REDACTION\_NAME\_LEVEL A new log level to use for the log message if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`PRIORITIZE`** . #### INRUPT\_LOGGING\_REDACTION\_NAME\_PATTERN A regex (see [Java regex pattern](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/regex/Pattern.html#sum) ) to match in the log messages. Configure to target log message text that matches a specified pattern. For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). #### INRUPT\_LOGGING\_REDACTION\_NAME\_REPLACEMENT Replacement text to use if the **`INRUPT_LOGGING_REDACTION_{NAME}_ACTION`** is **`REPLACE`** . If unspecified, defaults to **`[REDACTED]`** . For more information on log redaction, see [Logging Redaction](https://docs.inrupt.com/ess/2.5/administration/logging/logging-redaction). ### Application-Defined Metadata Propagation #### INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_ALLOW A comma-separated list of application-defined properties that can be included in the associated [audit events](https://github.com/inrupt/docs-gitbook/blob/main/ess/security/auditing/README.md#audit-event-message-internal-format) (unless specified in the corresponding [**`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_DENY`**](#inrupt_audit_producer_request_metadata_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To include a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_AUDIT\_PRODUCER\_REQUEST\_METADATA\_DENY A comma-separated list of application-defined properties to exclude from the associated audit messages. This setting takes precedence over [**`INRUPT_AUDIT_PRODUCER_REQUEST_METADATA_ALLOW`**](#inrupt_audit_producer_request_metadata_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_LOGGING\_REQUEST\_METADATA\_ALLOW A comma-separated list of application-defined properties that can be included in the associated [log messages](https://github.com/inrupt/docs-gitbook/blob/main/enterprise-solid-server/2.5/services/installation/customize-configurations/customization-logging/manage-app-defined-metadata.md) (unless specified in the corresponding [**`INRUPT_LOGGING_REQUEST_METADATA_DENY`**](#inrupt_logging_request_metadata_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To include a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_LOGGING\_REQUEST\_METADATA\_DENY A comma-separated list of application-defined properties to exclude from the associated log messages. This setting takes precedence over [**`INRUPT_LOGGING_REQUEST_METADATA_ALLOW`**](#inrupt_logging_request_metadata_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_ALLOW A comma-separated list of non-baggage request headers to add to the [baggage](https://www.w3.org/TR/baggage/) (unless specified in the corresponding [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_DENY`**](#inrupt_request_metadata_propagator_header_deny) ); i.e., include these non-baggage request headers as application-defined properties. The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_DENY A comma-separated list of non-baggage request headers to exclude from being added to the [baggage](https://www.w3.org/TR/baggage/) ; i.e., excludes these headers as application-defined properties. This setting takes precedence over [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) . The configuration is case-insensitive; i.e., the listed headers do **not** need to match the case of the client request headers. For example, a list that includes **`x-correlation-id`** can match (and exclude) **`x-correlation-id`** header, **`X-CoRrElAtIoN-Id`** header, etc. See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_REQUEST\_METADATA\_PROPAGATOR\_HEADER\_OVERRIDES A flag that determines ESS behavior when metadata property is defined both as a header and as a baggage entry: * If **`true`** , ESS updates/overrides the baggage entry with the header value. * If **`false`** (the default), ESS keeps the baggage entry. For details, [Duplicate Property Definition](https://docs.inrupt.com/ess/administration/application-defined-metadata#duplicate-property-definition) #### INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_ALLOW A comma-separated list of application-defined properties that can return as response headers (unless specified in the corresponding [**`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_DENY`**](#inrupt_request_metadata_reflector_header_deny) ). This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip** * To return a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. * You may need to update **`QUARKUS_HTTP_CORS_EXPOSED_HEADERS`** to extend the list of [CORS-safelisted response headers](https://developer.mozilla.org/en-US/docs/Glossary/CORS-safelisted_response_header) . {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. #### INRUPT\_REQUEST\_METADATA\_REFLECTOR\_HEADER\_DENY A comma-separated list of application-defined properties to exclude from returning as response headers. This setting takes precedence over [**`INRUPT_REQUEST_METADATA_REFLECTOR_HEADER_ALLOW`**](#inrupt_request_metadata_reflector_header_allow) . This configuration is **case-sensitive** to the propagated properties in the baggage. {% hint style="info" %} **Tip**\ To exclude a propagated property that was added via the [**`INRUPT_REQUEST_METADATA_PROPAGATOR_HEADER_ALLOW`**](#inrupt_request_metadata_propagator_header_allow) configuration, ensure that the cases of these properties match. {% endhint %} See: * [Manage Application-Defined Metadata Propagation](https://docs.inrupt.com/ess/2.5/installation/customize-configurations/customization-logging/manage-app-defined-metadata) to configure. * [Application-Defined Metadata](https://docs.inrupt.com/ess/2.5/administration/application-defined-metadata) for more information. ## Additional Information See also [Quarkus Configuration Options](https://quarkus.io/guides/all-config)