Streamvisor Docs
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Streamvisor Docs
  2. /
  3. Installation
  4. /
  5. Configuration Reference

Configuration Reference

Below is a reference of all configuration properties.

To convert properties in their canonical form to environment variables, please follow these rules:

  1. Replace dots (.) with underscores (_).
  2. Remove any dashes (-).
  3. Convert to uppercase.

E.g. streamvisor.bootstrap-admin.enable becomes STREAMVISOR_BOOTSTRAPADMIN_ENABLE.

Property Description Required Type Default
streamvisor.pulsar.connection.auth.plugin Classname for Pulsar authentication provider false string
streamvisor.pulsar.connection.auth.params Parameters for Pulsar authentication provider false string
streamvisor.pulsar.connection.tls.key-file-path Path to the TLS key file false string
streamvisor.pulsar.connection.tls.certificate-file-path Path to the TLS certificate file false string
streamvisor.pulsar.connection.tls.trust-certs-file-path Path to the trusted CA certificate file for TLS false string
streamvisor.pulsar.connection.tls.insecure-connection.allow If true, accept untrusted TLS certificate from Pulsar broker false boolean false
streamvisor.pulsar.connection.tls.use-key-store If true, uses keystore TLS instead of PEM type configuration false boolean false
streamvisor.pulsar.connection.tls.trust-store.type File format of the trust store file false string JKS
streamvisor.pulsar.connection.tls.trust-store.path Path to the trust store file false string
streamvisor.pulsar.connection.tls.trust-store.password Password for the trust store file false string
streamvisor.pulsar.connection.tls.key-store.type File format of the key store file false string JKS
streamvisor.pulsar.connection.tls.key-store.path Path to the key store file false string
streamvisor.pulsar.connection.tls.key-store.password Password for the key store file false string
streamvisor.pulsar.connection.tls.hostname-verification.enable If true, verify server identity hostname (RFC 2818) when connecting to Pulsar broker false boolean false
streamvisor.pulsar.connection.lookup-service-port.override Override Pulsar lookup service port. There is a bug in Pulsar <=3.1.0, <=3.0.1, <=2.11.3 that returns the wrong webservice port when using TLS. If you are using an affected version of Pulsar with TLS enabled, please set this property to the same value as the webServicePortTls in your Pulsar proxy/broker.conf false int
streamvisor.bootstrap-admin.enable If true, bootstraps an admin user false boolean true
streamvisor.bootstrap-admin.email Bootstrapped admin user email false string admin@example.com
streamvisor.bootstrap-admin.password Bootstrapped admin user password false string streamvisor
streamvisor.bootstrap-env.enable If true, bootstraps an environment false boolean false
streamvisor.bootstrap-env.name Bootstrapped environment name false string playground
streamvisor.bootstrap-env.service-url Bootstrapped environment Pulsar web service url false string http://localhost:8080
streamvisor.bootstrap-env.broker-url Bootstrapped environment Pulsar broker service url false string pulsar://localhost:6650
streamvisor.bootstrap-env.token Bootstrapped environment Pulsar authentication JWT false string
streamvisor.license.filepath Path to Streamvisor license file false string
streamvisor.rbac.enable If true, enables role-based access control false boolean false
streamvisor.sso.oauth.providers.{providerName}.clientId OAuth 2.0 client id false string
streamvisor.sso.oauth.providers.{providerName}.clientSecret OAuth 2.0 client secret. Only required when using Google as the provider false string
streamvisor.sso.oauth.providers.{providerName}.issuerUri Issuer URI to check on the token. Also used to retrieve the well-known configuration false string
streamvisor.sso.oauth.providers.{providerName}.scopes Comma-separated list of scopes to be requested for the token, e.g. openid,profile,email false string
streamvisor.sso.oauth.providers.{providerName}.emailClaim Claim name for retrieving the user email false string email
streamvisor.sso.oauth.providers.{providerName}.groupsClaim Claim name for retrieving groups for group-mapping false string
streamvisor.persistence.url JDBC URL when using PostgreSQL as the persistence type, e.g. jdbc:postgresql://127.0.0.1:5432/streamvisor false string
streamvisor.persistence.driver-class-name JDBC driver class name when using PostgreSQL as the persistence type, e.g. org.postgresql.Driver false string
streamvisor.persistence.username database username when using PostgreSQL as the persistence type false string
streamvisor.persistence.password database password when using PostgreSQL as the persistence type false string