> For the complete documentation index, see [llms.txt](https://docs.collibra.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.collibra.com/data-quality-self-hosted/installation/installing-data-quality-observability-self-hosted-on-self-hosted-spark-standalone/additional-spark-standalone-configuration-options.md).

# Additional Spark Standalone configuration options

This section describes additional configuration options in `setup.sh`, `owl-env.sh`, and `owl.properties`.

{% hint style="info" %}
To see the directory structure created by `setup.sh`, go to [Data Quality & Observability (self-hosted) Directory Structure](/data-quality-self-hosted/architecture/data-quality-observability-self-hosted-directory-structure.md).
{% endhint %}

## Setting additional options in setup.sh

The following table describes the arguments supported by `setup.sh`:

<table><thead><tr><th width="152">Argument</th><th>Description</th></tr></thead><tbody><tr><td><code>-non-interactive</code></td><td>Skips asking to accept Java license agreement.</td></tr><tr><td><code>-skipSpark</code></td><td>Skips the extraction of Spark components.</td></tr><tr><td><code>-stop</code></td><td>Do not automatically start all components (Owl-Web, Zeppelin, Postgres).</td></tr><tr><td><code>-port=</code></td><td>Set DQ Web application to use the defined port.</td></tr><tr><td><code>-user=</code></td><td>Optional parameter to set the user to run Collibra DQ. The default is the current user.</td></tr><tr><td><code>-owlbase=</code></td><td>Sets the base path to where you want Collibra DQ installed.</td></tr><tr><td><code>-owlpackage=</code></td><td>Optional parameter to set the Collibra DQ package directory. The default is the current working directory.</td></tr><tr><td><code>-help</code></td><td>Display this help and exit.</td></tr><tr><td><code>-options=</code></td><td>The different Collibra DQ components to install in a comma-separated list format. For example, -options=owlagent,owlweb,postgres,spark</td></tr><tr><td><code>-pgpassword=</code></td><td>The password used to set for the PostgreSQL metastore. For unattended installs.</td></tr><tr><td><code>-pgserver=</code></td><td>The name of the PostgreSQL server. For example, -pgserver=owl-postgres-host.example.com:5432/owldb. For unattended installs.</td></tr></tbody></table>

### Example setup.sh commands

A common example of the `setup.sh` command is:

**`./setup.sh -port=9000 -user=ec2-user -owlbase=/home/ec2-user -owlpackage=/home/ec2-user/packages`**

* The tar ball extracted to this folder on my EC2 Instance: *\*\*\*\**`/home/ec2-user/packages/`
* Collibra DQ is running as the *\*\*\*\**`ec2-user`
* The DQ Web application runs on port `9000`
* The base location for the setup.sh script to create the will be: `/home/ec2-user/`

This example installs only the DQ Agent:

**`./setup.sh -user=ec2-user -owlbase=/home/ec2-user -owlpackage=/home/ec2-user/package -options=owlagent`**

* The package extracted to this folder on my EC2 Instance: *\*\*\*\**`/home/ec2-user/packages/`
* Owl-agent is running as the *\*\*\*\**`ec2-user`
* The base location for the setup.sh script to create the Collibra DQ folder and place all packages under Collibra DQ is: `/home/ec2-user/`

## Configuring environment settings with owl-env.sh

The `owl-env.sh` script holds the main variables that are reused across components. It is executed from the `/owl/config` directory.

| owl-env.sh scripts                                                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| ------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `export SPARK_CONF_DIR="/home/collibra/owl/cdh-spark-conf"`              | The directory on your machine where the Spark conf directory resides.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `export INSTALL_PATH="/home/collibra/owl"`                               | The installation directory of Collibra DQ.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `export JAVA_HOME="/home/collibra/jdk1.8.0_131"`                         | Java Home for Collibra DQ to leverage.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `export LOG_PATH="/home/collibra/owl/log"`                               | The log path.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `export BASE_PATH="/home/collibra"`                                      | The base location under which the Collibra DQ directory resides.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `export SPARK_MAJOR_VERSION=2`                                           | Spark Major version. Collibra DQ only supports 2+ version of Spark.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `export OWL_LIBS="/home/collibra/owl/libs"`                              | Lib Directory to inject in spark-submit jobs.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `export USE_LIBS=0`                                                      | <p>Use the lib directory or not. 0 is the default.A value of 0 means the lib directory is not used.</p><p>A value of 1 means the lib directory is used.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `export SPARKSUBMITEXE="spark-submit"`                                   | Spark submit executable command. Collibra DQ using spark-submit as an example.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| `export ext_pass_manage=0`                                               | If using a password management system. You can enable for password to be pulled from it.A value of 0 disables an external password management system.A value of 1 enables an external password management system.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `export ext_pass_script="/opt/owl/bin/getpassword.sh"`                   | Leverage password script to execute a get password script from the vault.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `TIMEOUT=900 #15 minutes in seconds`                                     | Owl-Web user time out limits.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `export LOCAL_REGISTRATION_ENABLED=false`                                | Disables the Registration link on the login page, thereby preventing the creation of new user accounts.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `PORT=9003 #owl-web port NUMBER`                                         | The default port to use for owl-web.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `export SPRING_LOG_LEVEL=ERROR`                                          | The logging level to be displayed in the owl-web.log                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| `export SPRING_DATASOURCE_DRIVER_CLASS_NAME=org.postgresql.Driver`       | The driver class name for postgres metastore (used by web).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| `export SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/postgres` | JDBC connection string to Collibra DQPostgreSQL metastore.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| `export SPRING_DATASOURCE_USERNAME=collibra`                             | Collibra DQPostgreSQL username.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `export SPRING_DATASOURCE_PASSWORD=3+017wfY1l1vmsvGYAyUcw5zGL`           | Collibra DQPostgreSQL password.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `export AUTOCLEAN=TRUE/FALSE`                                            | TRUE/FALSE Enable/Disable automatically delete old datasets.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `export DATASETS_PER_ROW=200000`                                         | Delete datasets after this threshold is hit (must be greater than the default to change).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `export ROW_COUNT_THRESHOLD=300000`                                      | Delete rows after this threshold is hit (must be greater than the default to change).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `export SERVER_HTTP_ENABLED=true`                                        | Enabling HTTP to owl web                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `export OWL_ENC=OFF #JAVA for java encryption`                           | Enable Encryption (NOTE need to add to owl.properties also). Has to be in form owl.enc=OFF within owl.properties file to disable, and in this form owl.enc=JAVA to enable. the owl.properties file is located in the owl install path /config folder (/opt/owl/config).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `PGDBPATH=/home/collibra/owl/owl-postgres/bin/data`                      | Path for PostgreSQL DB                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `export RUNS_THRESHOLD=5000`                                             | Delete runs after this threshold is hit (must be greater than the default to change).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `export HTTP_SECONDARY_PORT=9001`                                        | Secondary HTTP port to use which is useful when SSL is enabled.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| `export SERVER_PORT=9000`                                                | Same as PORT.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `export SERVER_HTTPS_ENABLED=true`                                       | Enabling of SSL.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `export SERVER_SSL_KEY_TYPE=PKCS12`                                      | Certificate trust store.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| `export SERVER_SSL_KEY_PASS=t2lMFWEHsQha3QaWnNaR8ALaFPH15Mh9`            | Certificate key password.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| `export SERVER_SSL_KEY_ALIAS=owl`                                        | Certificate key alias.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `export SERVER_REQUIRE_SSL=true`                                         | Override HTTP on and force HTTPS regardless of HTTP settings.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| `export MULTITENANTMODE=FALSE`                                           | Flipping to TRUE will enable multi tenant support.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| `export multiTenantSchemaHub=owlhub`                                     | Schema name used for multi tenancy.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| `export OWL_SPARKLOG_ENABLE=false`                                       | Enabling deeper spark logs when toggled to true.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `export LDAP_GROUP_RESULT_DN_ATTRIBUTE`                                  | <p>The attribute to the full path of the group object, for example, <strong>CN=OwlAppAdmin</strong>,<strong>OU=OwlGroups</strong>,<strong>OU=Groups</strong>,<strong>DC=owl</strong>, <strong>DC=com</strong>.</p><p>Default is <strong>distinguishedname</strong>.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `export LDAP_GROUP_RESULT_NAME_ATTRIBUTE`                                | <p>The attribute to the simple name of the group, for example, <strong>OwlAppAdmin</strong>.</p><p>Default is <strong>CN</strong>.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| `export LDAP_GROUP_RESULT_CONTAINER_BASE`                                | Property used in the scenario where the LDAP\_GROUP\_RESULT\_DN\_ATTRIBUTE does not return a value. In this case, the LDAP\_GROUP\_RESULT\_NAME\_ATTRIBUTE prepends to this value, which creates a fully qualified LDAP path. For example, **OU=OwlGroups**,**OU=Groups**,**DC=owl**,**DC=com**. Default is <**null**>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| `export ALLOWED_LOCAL_PATHS='*'`                                         | <p>Enables Collibra DQ to use the specified local paths. Wildcard (<strong>'\*'</strong>) is allowed. Separate multiple paths using a comma.</p><p>You must configure the ALLOWED\_LOCAL\_PATHS variable in either "owl-env.sh" or "ConfigMap" to specify all local file base paths where files, such as drivers, are stored. Ensure you set this variable for both "dq-web" and "dq-agent" configurations if the configurations are not shared.</p><p>For example: If DQ Classic is installed to /home/collibradq/owl and JDBC drivers are located at /home/collibradq/owl/drivers, then /home/dq/config/owl-env.sh should include the following: <code>export ALLOWED\_LOCAL\_PATHS=/opt/collibradq/owl</code></p><p>If drivers are stored in a different directory structure, such as /data/storage/owl/drivers, then you must append that to the configuration.</p> |
| `export SERVER_FORWARD_HEADERS_STRATEGY=FRAMEWORK`                       | Resolves an issue related to how Spring Boot handles forwarded headers that can cause an error to occur during login.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `export EXPLORER_DAO_POOL_CONNECTIONCLEANERINTERVALMSECS=3600000`        | <p>The interval, in milliseconds, at which the connection pool checks for idle connections to close. The default value is 60000 (every 60 seconds). Set to 3600000 to run the cleaner once per hour, which reduces background keep-alive calls by approximately 98% compared to the default.</p><div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>The keep-alive check runs uniformly across all connections in the pool. You cannot restrict validation to a single data source or connection alias. For example, if you have six Databricks connections configured, all six undergo validation during each cleaner cycle.</p></div>                                                                                                                                                                                               |
| `export EXPLORER_DAO_POOL_MAXIDLESECS=3600`                              | The maximum number of seconds a connection can remain idle before the connection pool closes it. Set this value to align with `EXPLORER_DAO_POOL_CONNECTIONCLEANERINTERVALMSECS`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| `export EXPLORER_DAO_POOL_CONNECTIONMAXAGESECS=3600`                     | The maximum age, in seconds, of a connection before the connection pool closes and replaces it. Set this value to align with `EXPLORER_DAO_POOL_CONNECTIONCLEANERINTERVALMSECS`.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| `export DQ_PUSHDOWN_MAX_CONCURRENT_JOBS`                                 | The system-wide maximum number of concurrent pushdown jobs allowed across all tenants. This limit applies in addition to the existing per-tenant limit (a pushdown job needs both to run). If the value is unset or invalid, Data Quality & Observability (self-hosted) uses the default. Requires a restart to take effect.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| `export RESTRICT_CROSSDB_REFERENCE=true`                                 | Controls whether Data Quality & Observability (self-hosted) checks that SQL queries reference only tables in the approved schemas of a connection before sending the queries to the source database. When set to true, the check is enabled. When set to false, no check is performed. The default is false. This variable is the main switch for cross-database schema reference validation. The DEPRECATED\_CROSS\_DB\_LEGACY\_PARSER\_ENABLED and DEPRECATED\_MANUAL\_QUERY\_AUTO\_ESCAPING\_ENABLED settings on the [Application Configuration Settings page](/data-quality-self-hosted/admin-configuration/admin-console/configuration-settings/application-configuration-settings.md) have an effect only when this variable is set to true. Requires a restart to take effect.                                                                                   |

## Configuring properties with owl.properties

The `owl.properties` file enables you to set the following properties. It is located in the `/owl/config` directory:

| Example                                                             | Description                                                            |
| ------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `key=XXXXXX`                                                        | The license key.                                                       |
| `spring.datasource.url=jdbc:postgresql://localhost:5432/postgres`   | The connection string to the Collibra DQ metastore (used by owl-core). |
| `spring.datasource.password=xxxxxx`                                 | The password to the Collibra DQ metastore (used by owl-core).          |
| `spring.datasource.username=xxxxxx`                                 | The username to the Collibra DQ metastore (used by owl-core).          |
| `spring.datasource.driver-class-name=com.owl.org.postgresql.Driver` | Shaded PostgreSQL driver class name.                                   |
| `spring.agent.datasource.url`                                       | jdbc:postgresql://$host:$port/owltrunk                                 |
| `spring.agent.datasource.username`                                  | {user}                                                                 |
| `spring.agent.datasource.passwords`                                 | {password}                                                             |
| `spring.agent.datasource.driver-class-name`                         | org.postgresql.Driver                                                  |

## Validation Patterns

Collibra DQ supports pattern validation for some commonly used IDs and names. Go to [Pattern validation for commonly used names](/data-quality-self-hosted/admin-configuration/more-admin-settings/pattern-validation-for-commonly-used-names.md).

## IPv6 Compliance

This section provides additional steps for deploying Collibra DQ Standalone in an IPv6-compliant environment.

### Steps

1. Add the following properties to the spark-env.sh file and restart the Spark driver and worker services.

   ```
   export SPARK_PUBLIC_DNS=:::7077
   export SPARK_DAEMON_JAVA_OPTS="-Djava.net.preferIPv6Addresses=true"
   export SPARK_LAUNCHER_OPTS="-Djava.net.preferIPv6Addresses=true"
   ```
2. Set the following extra JVM option to the owl-env.sh properties and restart the DQ Web and Agent services

   ```
   # Append -Djava.net.preferIPv6Addresses=true to the EXTRA_JVM_OPTIONS of the owl-env.sh
   export EXTRA_JVM_OPTIONS="-Djava.net.preferIPv6Addresses=true --add-opens java.base/java.util=ALL-UNNAMED --add-opens java.base/java.net=ALL-UNNAMED --add-opens java.base/sun.nio.ch=ALL-UNNAMED --add-opens java.base/java.nio=ALL-UNNAMED --add-opens java.base/sun.util.calendar=ALL-UNNAMED"
   # Append -Djava.net.preferIPv6Addresses=true to the AGENT_EXTRA_JVM_OPTIONS of the owl-env.sh
   export AGENT_EXTRA_JVM_OPTIONS="-Djava.net.preferIPv6Addresses=true"
   ```
