@hyperlane-xyz/core

[//]: # (Documentation generated from docs/secrets.toml - DO NOT EDIT.) This document describes the TOML format for secrets. Each secret has an alternative corresponding environment variable. See also [CONFIG.md](CONFIG.md) ## Example ```toml [Database] URL = 'postgresql://user:pass@localhost:5432/dbname?sslmode=disable' # Required [Password] Keystore = 'keystore_pass' # Required ``` ## Database ```toml [Database] URL = "postgresql://user:pass@localhost:5432/dbname?sslmode=disable" # Example BackupURL = "postgresql://user:pass@read-replica.example.com:5432/dbname?sslmode=disable" # Example AllowSimplePasswords = false # Default ``` ### URL ```toml URL = "postgresql://user:pass@localhost:5432/dbname?sslmode=disable" # Example ``` URL is the PostgreSQL URI to connect to your database. Chainlink nodes require Postgres versions >= 11. See [Running a Chainlink Node](https://docs.chain.link/docs/running-a-chainlink-node/#set-the-remote-database_url-config) for an example. Environment variable: `CL_DATABASE_URL` ### BackupURL ```toml BackupURL = "postgresql://user:pass@read-replica.example.com:5432/dbname?sslmode=disable" # Example ``` BackupURL is where the automatic database backup will pull from, rather than the main CL_DATABASE_URL. It is recommended to set this value to a read replica if you have one to avoid excessive load on the main database. Environment variable: `CL_DATABASE_BACKUP_URL` ### AllowSimplePasswords ```toml AllowSimplePasswords = false # Default ``` AllowSimplePasswords skips the password complexity check normally enforced on URL & BackupURL. Environment variable: `CL_DATABASE_ALLOW_SIMPLE_PASSWORDS` ## WebServer.LDAP ```toml [WebServer.LDAP] ServerAddress = 'ldaps://127.0.0.1' # Example ReadOnlyUserLogin = 'viewer@example.com' # Example ReadOnlyUserPass = 'password' # Example ``` Optional LDAP config ### ServerAddress ```toml ServerAddress = 'ldaps://127.0.0.1' # Example ``` ServerAddress is the full ldaps:// address of the ldap server to authenticate with and query ### ReadOnlyUserLogin ```toml ReadOnlyUserLogin = 'viewer@example.com' # Example ``` ReadOnlyUserLogin is the username of the read only root user used to authenticate the requested LDAP queries ### ReadOnlyUserPass ```toml ReadOnlyUserPass = 'password' # Example ``` ReadOnlyUserPass is the password for the above account ## Password ```toml [Password] Keystore = "keystore_pass" # Example VRF = "VRF_pass" # Example ``` ### Keystore ```toml Keystore = "keystore_pass" # Example ``` Keystore is the password for the node's account. Environment variable: `CL_PASSWORD_KEYSTORE` ### VRF ```toml VRF = "VRF_pass" # Example ``` VRF is the password for the vrf keys. Environment variable: `CL_PASSWORD_VRF` ## Pyroscope ```toml [Pyroscope] AuthToken = "pyroscope-token" # Example ``` ### AuthToken ```toml AuthToken = "pyroscope-token" # Example ``` AuthToken is the API key for the Pyroscope server. Environment variable: `CL_PYROSCOPE_AUTH_TOKEN` ## Prometheus ```toml [Prometheus] AuthToken = "prometheus-token" # Example ``` ### AuthToken ```toml AuthToken = "prometheus-token" # Example ``` AuthToken is the authorization key for the Prometheus metrics endpoint. Environment variable: `CL_PROMETHEUS_AUTH_TOKEN` ## Mercury.Credentials.Name ```toml [Mercury.Credentials.Name] Username = "A-Mercury-Username" # Example Password = "A-Mercury-Password" # Example URL = "https://example.com" # Example LegacyURL = "https://example.v1.com" # Example ``` ### Username ```toml Username = "A-Mercury-Username" # Example ``` Username is used for basic auth of the Mercury endpoint ### Password ```toml Password = "A-Mercury-Password" # Example ``` Password is used for basic auth of the Mercury endpoint ### URL ```toml URL = "https://example.com" # Example ``` URL is the Mercury endpoint base URL used to access Mercury price feed ### LegacyURL ```toml LegacyURL = "https://example.v1.com" # Example ``` LegacyURL is the Mercury legacy endpoint base URL used to access Mercury v0.2 price feed ## Threshold ```toml [Threshold] ThresholdKeyShare = "A-Threshold-Decryption-Key-Share" # Example ``` ### ThresholdKeyShare ```toml ThresholdKeyShare = "A-Threshold-Decryption-Key-Share" # Example ``` ThresholdKeyShare used by the threshold decryption OCR plugin