topazdb/core repository overview

⁠TopazDB Core

The combined TopazDB stack, comprised of the following docker containers:

• topazdb/core - gateway for accessing both the GUI and API
• topazdb/gui⁠ - TopazDB's graphical user interface and API consumer
• topazdb/api⁠ - TopazDB's REST API
• topazdb/server⁠ - TopazDB's mysql backend

⁠Configuration Variables

⁠Environment

These configuration variables must be present on your system as environment variables. It is recommended that they are exported in your .xprofile

⁠TOPAZ_ENV

Possible Values: "production" or "development"
Setting this to development will build Topaz from the source files and turn on auto-rebuilds for the GUI and API. If set to production, the official images will be pulled from Docker Hub and used in place of the source files.

⁠TOPAZ_NOMOUNT

Development Mode Only
Possible Values: true or false
Default Value: false
If true, Sunny will not be automatically mounted to your system when Topaz starts. In production, it is assumed that Sunny will already be mounted to the host. **

⁠Database/MySQL

Variables for controlling MySQL setup and connectivity. These can be present as environment variables or placed in a .env file within the same directory as docker-compose[.production].yml.

⁠TOPAZ_USER

Possible Values: any string
Example: johndoe
Database/mysql username to use.

⁠TOPAZ_PASSWORD

Possible Values: any string
Example: (UZg2]XxYnV&-CQ
Database/mysql password to use.

⁠TOPAZ_DATABASE

Possible Values: any string
Example: topazdb
Database name to use within mysql

⁠Okta

Variables for integrating with Okta. These can be present as environment variables or placed in a .env file. TopazDB implements the OpenID connect authorization code flow.⁠

⁠TOPAZ_OKTA_DOMAIN

Possible Values: URL in the form of protocol://hostname/path
Example: example.oktapreview.com
The Okta domain to use for SSO/Identity management.

⁠TOPAZ_OKTA_CLIENTID

Possible Values: OAuth 2.0 Token/Identifier
Example: 0oabv6kx4qq6h1U5l0h7
The Client ID from Okta. See this page⁠ for locating your client id.

⁠TOPAZ_OKTA_CLIENTSECRET

Possible Values: OAuth 2.0 Token
The Client Secret from Okta. See this page⁠ for locating your client secret.

⁠TOPAZ_OKTA_REDIRECTURI

Possible Values: URI/URL in the form of protocol://hostname/path
Example: http://localhost/⁠
The URI/URL to redirect to after a successful sign-on.

⁠TOPAZ_OKTA_AUTHSERV

Possible Values: any string
Default Value: default
The Okta Authorization server⁠ to use.

⁠Miscellaneous

Miscellaneous variables. These can be present as environment variables or placed in a .env file.

⁠TOPAZ_BASEURL

Possible Values: a URL in the form of protocol://hostname/path
Example: http://localhost/⁠
The URL where TopazDB should be accessible at.