Platform Configuration
This document describes all the configuration/secret variables that are used by OpenDAX v4
The following variables have to be set in Kubernetes secrets.
Configs for Helm hooks with infrastructure values
Secret | Description | Example |
|---|---|---|
DATABASE_HOST | Database host address | 0.0.0.0 |
DATABASE_PORT | Database port | 5432 |
DATABASE_ROOT_PASSWORD | Database root password | <nil> |
DATABASE_ROOT_USER | Database root user | <nil> |
INFLUX_HOST | Influx database host address | 0.0.0.0 |
INFLUX_PORT | Influx database port | 8086 |
Contains two Supabase keys
Secret | Description | Example |
|---|---|---|
ANON_KEY | Supabase Anon Key | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHA... |
SERVICE_KEY | Supabase Service Key | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHA... |
Finex is the core of OpenDAX v4, it handles all trading, blockchain, and liquidity network operations
Secret | Description | Example |
|---|---|---|
FINEX_ACTIONS_REQUIRE_QUOTE_AMOUNT_ROLES | Quote amount role | sa_maker |
FINEX_CUSTODY_BROKER_PASSPHRASE | Finex private key passphrase | c1d658a2c93b6216 |
FINEX_CUSTODY_BROKER_PRIVATE_KEY | Finex encoded private key | eyJjaXBoZXIiOiJhZXMtMTI4LWN0ciIsImNpcGhlcnRl... |
FINEX_CUSTODY_BROKER_PUBLIC_KEY | Finex eth address derived from public key | 0xE3eB31EbA39Ed99Fc7d85A4a24870F56653bF977 |
FINEX_CUSTODY_RPC_URL | Custody RPC URL | wss://rinkeby.infura.io/ws/v3/3456... |
FINEX_DATABASE_DRIVER | Influx database driver | postgres |
FINEX_DATABASE_HOST | Finex database host address | 0.0.0.0 |
FINEX_DATABASE_NAME | Finex database name | opendax_opendax |
FINEX_DATABASE_PASSWORD | Finex database password | o69HW2QUgJ2x5bsf |
FINEX_DATABASE_PORT | Finex database port | 5432 |
FINEX_DATABASE_SCHEMA | Finex database schema | finex |
FINEX_DATABASE_USERNAME | Finex database username | finex_opendax |
FINEX_DEPLOYMENT_ID | Deployment ID | opendax |
FINEX_INFLUX_DATABASE | Influx database name | finex_opendax |
FINEX_INFLUX_HOST | Influx database host address | 0.0.0.0 |
FINEX_INFLUX_PASSWORD | Influx database password | WTBhEDSIMr34qNmJ |
FINEX_INFLUX_PORT | Influx database port | 8086 |
FINEX_INFLUX_SCHEME | Influx database scheme | http |
FINEX_INFLUX_USERNAME | Influx database username | opendax |
FINEX_LOG_LEVEL | Log level | debug |
FINEX_MODE | Running mode: prod, test | prod |
FINEX_VAULT_ADDR | Finex vault address | http://0.0.0.0:8200 |
FINEX_VAULT_APP | Finex vault app name | opendax |
FINEX_WS_GOTRUE_PUB_KEY | Websocket gotrue public key | LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lq... |
FINEX_YELLOW_NETWORK_PRIVATE_KEY | Finex Yellow Network private key | 0xc81bde2b794fca42baf5903770c9445b828fe87334... |
FINEX_YELLOW_NETWORK_RPC_URL | Yellow Network RPC URL | wss://rinkeby.infura.io/ws/v3/3456... |
KAIGARA_DB_PASS | Kaigara database password | 9uQtJqzYHz5JKZPd |
Signer is a microservice responsible for signing deposit/withdrawal tickets
Secret | Description | Example |
|---|---|---|
SIGNER_DATABASE_DRIVER | Database driver | postgres |
SIGNER_DATABASE_HOST | Signer database host address | 0.0.0.0 |
SIGNER_DATABASE_NAME | Finex database name | opendax_opendax |
SIGNER_DATABASE_PASSWORD | Finex database password | 7BaehaCndhhjKSKg |
SIGNER_DATABASE_PORT | Signer database port | 5432 |
SIGNER_DATABASE_SCHEMA | Finex database schema | signer |
SIGNER_DATABASE_USERNAME | Finex database username | signer_opendax |
SIGNER_DEPLOYMENT_ID | Deployment ID | opendax |
SIGNER_FINEX_PUBLIC_KEY | Finex public key | 0x0450c86930e43d6d1b8f1c64d4ac9e4380e76feb37... |
SIGNER_GOTRUE_PUB_KEY | Gotrue public key | LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lq... |
SIGNER_KMS_PROVIDER | Avaliable kms providers: local, gcp, aws | local |
SIGNER_NETWORK | Running network: testnet, mainnet | testnet |
SIGNER_PRIVATE_KEY | Signer private key | 0xbbb8311aad989d5c5cb5b3f3d761d6a66f8f97410f... |
SIGNER_VAULT_ADDR | Signer vault address | http://0.0.0.0:8200 |
SIGNER_VAULT_TOKEN | Signer vault token | changeme |
Secret | Description | Example |
|---|---|---|
INFLUX_DB_NAME | Influx database name | finex_opendax |
JWT_PUBLIC_KEY | Frontdex gotrue public key | LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlJQ0lq... |
KAIGARA_DB_PASS | Kaigara database password | V71xBGwy885GMvnX |
NEXT_PUBLIC_CHAIN_ID | Custody chain ID | 4 |
NEXT_PUBLIC_INFURA_ID | Infura ID | your infura id |
SUPABASE_SERVICE_KEY | Supabase service key | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHA... |
Main authentication component responsible for user management
Secret | Description | Example |
|---|---|---|
DATABASE_URL | Database URL | postgres://gotrue_opendax:[email protected] |
DB_NAMESPACE | Database namespace | auth |
GOTRUE_API_HOST | Gotrue API hostname to listen on. | 0.0.0.0 |
GOTRUE_COOKIE_DURATION | Cookie duration in seconds | 3600 |
GOTRUE_DATABASE_HOST | Database host address | 0.0.0.0 |
GOTRUE_DATABASE_NAME | Database name | opendax_opendax |
GOTRUE_DATABASE_PASSWORD | Database password | a6GtMqi7fKA1VQ0P |
GOTRUE_DATABASE_USERNAME | Database username | gotrue_opendax |
GOTRUE_DB_DRIVER | Database driver | postgres |
GOTRUE_DISABLE_SIGNUP | When signup is disabled the only way to create new users is through invites. | false |
GOTRUE_FIRST_USER_SUPER_ADMIN | Makes the first user superadmin | true |
GOTRUE_JWT_ALGORITHM | JWT signing algorithm | RS256 |
GOTRUE_JWT_DEFAULT_GROUP_NAME | The default group to assign all new users to. | user |
GOTRUE_JWT_EXP | How long tokens are valid for, in seconds. | 3600 |
GOTRUE_JWT_SECRET | The secret used to sign JWT tokens with. | LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpN... |
GOTRUE_MAILER_URLPATHS_CONFIRMATION | URL path to use in the signup confirmation email. | /api/v1/auth/verify |
GOTRUE_MAILER_URLPATHS_INVITE | URL path to use in the user invite email. | /api/v1/auth/verify |
GOTRUE_MAILER_URLPATHS_RECOVERY | URL path to use in the password reset email. | /api/v1/auth/verify |
GOTRUE_OPERATOR_TOKEN | The shared secret with an operator (usually Netlify) for this microservice. Used to verify requests have been proxied through the operator and the payload values can be trusted. | eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3M... |
GOTRUE_SMTP_ADMIN_EMAIL | SMTP admin email address | |
GOTRUE_SMTP_HOST | The mail server hostname to send emails through. | smtp.mailgun.org |
GOTRUE_SMTP_PASS | If the mail server requires authentication, the password to use. | changeme |
GOTRUE_SMTP_PORT | The port number to connect to the mail server on. | 25 |
GOTRUE_SMTP_USER | If the mail server requires authentication, the username to use. | changeme |
KAIGARA_DB_PASS | Kaigara database password | nFtubLyTIkEXHOc3 |
PostgREST provides an API that allows direct interaction(read, write data etc.) with PostgreSQL
Secret | Description | Example |
|---|---|---|
KAIGARA_DB_PASS | Kaigara database password | YiRFIzitsN49wHPX |
PGRST_DB_HOST | Postgres database host address | 0.0.0.0 |
PGRST_DB_NAME | Postgres database name | opendax_opendax |
PGRST_DB_PASS | Postgres database password | YgUzLn8YaZehR8ce |
PGRST_DB_PORT | Postgres database port | 5432 |
PGRST_DB_URI | Postgres database URI | postgres://postgrest_opendax:YgUzLn8YaZehR8c... |
PGRST_DB_USERNAME | Postgres database username | postgrest_opendax |
PGRST_JWT_ALGORITHM | Postgrest JWT signing algorithm | RS256 |
PGRST_JWT_SECRET_IS_BASE64 | To determine the Postgres JWT secret is base64 encoded | true |
PGRST_JWT_SECRET | eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiJO... |
This component provides a storage API that lets you manage assets on S3-compatible and disk-based storage solutions
Secret | Description | Example |
|---|---|---|
ANON_KEY | Storage anon key (used for unauthenticated access) | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHA... |
AWS_ACCESS_KEY_ID | S3 Access Key ID | <nil> |
AWS_SECRET_ACCESS_KEY | S3 Secret Access Key | <nil> |
DATABASE_URL | Storage database URL | postgres://storage_opendax:[email protected] |
FILE_SIZE_LIMIT | Maximum file size in bytes | 52428800 |
GLOBAL_S3_BUCKET | Your S3 bucket name | opendax-v4-uat-storage |
GLOBAL_S3_ENDPOINT | Your S3 storage provider endpoint | https://storage.googleapis.com |
KAIGARA_DB_PASS | Kaigara database password | UyG03CYZeuCTYWIl |
PGRST_JWT_ALGORITHM | Postgrest JWT signing algorithm | RS256 |
PGRST_JWT_SECRET_IS_BASE64 | To determine the Postgres JWT secret is base64 encoded | true |
PGRST_JWT_SECRET | The secret used to sign JWT tokens with. | LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpN... |
REGION | Specify your region here in needed | auto |
SERVICE_KEY | Storage service key (used for elevated access) | eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHA... |
STORAGE_DB_HOST | Storage database host address | 0.0.0.0 |
STORAGE_DB_NAME | Storage database name | opendax_opendax |
STORAGE_DB_PASS | Storage database password | fE4YfKsVTQF3XAD4 |
STORAGE_DB_USERNAME | Storage database username | storage_opendax |
Meta facilitates administrative functions for PostgreSQL, it's only available on K8s internal network and used by the admin panel
Secret | Description | Example |
|---|---|---|
KAIGARA_DB_PASS | Kaigara database password | 0Nlzri4GmxaIGbc8 |
PG_META_DB_HOST | Meta database host | 0.0.0.0 |
PG_META_DB_NAME | Meta database name | opendax_opendax |
PG_META_DB_PASSWORD | Meta database password | tw0aO-Q3tUsEvNrf |
PG_META_DB_PORT | Meta database port | 0.0.0.0 |
PG_META_DB_USER | Meta database username | meta_opendax |
This component listens to changes to PostgreSQL databases and broadcasts them over WebSocket API
Secret | Description | Example |
|---|---|---|
DB_HOST | Realtime database host | 0.0.0.0 |
DB_NAME | Realtime database name | opendax_opendax |
DB_PASSWORD | Realtime database password | mX1V9EevMPpmfnFC |
DB_PORT | Realtime database port | 5432 |
DB_USER | Realtime database username | realtime_opendax |
KAIGARA_DB_PASS | Kaigara database password | Ggup0oEf5tSJT66e |