Main Content

Configure Polyspace Access Database and Services

R2026b

The Polyspace Access App services include the Extract-Transform-Load (ETL), the Polyspace® Access™ database, and the Polyspace Access web server. These services manage uploaded results, storage, and exports, and update the data displayed in the user web interface.

Settings for the Polyspace Access services are configured in an .env file. Specify these variables before running the containers for your installation.

Local Database Settings

Use these variables with profiles localdb_all or localdb_data.

VariableDescriptionDefault
PSACCESS_DB_VOLUME

Full path to the folder where you store the database.

${DATA_DIR}/psaccess/db
PSACCESS_DB_PASSWORD

Password to authenticate connections to the database. The different Polyspace Access services use this password when they communicate with the database. Use this password if you are prompted for one while performing a database backup or clean up.

For more information on backing up or cleaning up your database, see Back Up Polyspace Access Database and Clean Up Polyspace Access Database

Specifying a value for this variable is mandatory.

admin

Deleting the database service and uninstalling Polyspace Access does not delete the results that you uploaded to the database from the data volume. To delete a data volume and its contents, manually delete the folder where you store the database.

The recommended best practice is to create a backup of this database monthly.

To see the current database password, run this command:

docker inspect polyspace-access-db-0-main | grep POSTGRES_PASSWORD

To change the database password, update the password twice:

  1. Enter the new password in the .env file to change the password in the Polyspace Access settings.

  2. Run this command on the machine where you installed Polyspace Access to update the password in the PostgreSQL database:

    docker exec -it polyspace-access-db-0-main psql --username postgres --dbname prs_data -c "ALTER ROLE postgres WITH PASSWORD [yourNewPassword]"

External Database Settings

You can optionally choose to use an external database as the storage for your Polyspace Access results.

To use an external database:

  • The external database must be named prs_data.

  • The owner of the external database prs_data must have username prs_data.

  • The roles prs_data and postgres must exist in the third party database.

Use these variables to configure the connection to your external PostgreSQL instance.

VariableDescription
PSACCESS_DB_HOSTExternal database hostname
PSACCESS_DB_PORTPort used to communicate with the external database
PSACCESS_DB_PASSWORDPassword for role prs_data

Any maintenance for the database should be set in your third party database management software.

ETL Settings

Set this variable to configure the working directory for the Extract-Transform-Load (ETL) service.

VariableDescriptionDefault
PSACCESS_ETL_BASEDIRWorking directory for ETL artifacts. The file common.yaml defines the names of each of the ETL directories.${DATA_DIR}/psaccess/etl

Server Settings

Set this variable to specify the license file for the Polyspace Access web server.

VariableDescriptionDefault
PSACCESS_SERVER_LICENSE_FILE

Full path to the network.lic license file that you created when you configured the Polyspace Access license. See Configure Polyspace Access License.

${LICENSE_FILE}

See Also

Topics