Server Config

Server

• clickhouse

  nullable object
  Show child properties
  • clickhouse.http_url

    string

    URL to the HTTP access port for ClickHouse.

  • clickhouse.native_url

    string

    URL to the native access port for ClickHouse.

  • clickhouse.password

    nullable string
  • clickhouse.provision_users

    nullable map
    Show child properties
    • clickhouse.provision_users[key].password

      string
    • clickhouse.provision_users[key].role

      string
      Show possible variants
      • admin
      • write
      • read_only
    • clickhouse.provision_users[key].username

      string
  • clickhouse.secure

    nullable boolean
  • clickhouse.username

    string
• cloudflare

  nullable object
  Show child properties
  • cloudflare.account_id

    string
  • cloudflare.auth_token

    string
  • cloudflare.backend_dispatcher_namespace

    nullable string
  • cloudflare.zone

    object
    Show child properties
    • cloudflare.zone.game

      nullable string
    • cloudflare.zone.job

      nullable string
    • cloudflare.zone.main

      nullable string
• cockroachdb

  nullable object
  Show child properties
  • cockroachdb.cluster_identifier

    string
  • cockroachdb.max_connections

    nullable integer
  • cockroachdb.min_connections

    nullable integer
  • cockroachdb.password

    nullable string
  • cockroachdb.provision_users

    nullable map

    Automatically provisions new users when migrating the database.

    Show child properties
    • cockroachdb.provision_users[key].password

      string
    • cockroachdb.provision_users[key].role

      string
      Show possible variants
      • read
      • read_write
    • cockroachdb.provision_users[key].username

      string
  • cockroachdb.url

    string
  • cockroachdb.username

    string
• foundationdb

  nullable object
  Show child properties
  • foundationdb.addresses

    object
    Show possible variants
    • Variant #1
      • foundationdb.addresses.dynamic

        object
        Show child properties
        • foundationdb.addresses.dynamic.fetch_endpoint

          string
    • Variant #2
      • foundationdb.addresses.static

        array of strings
  • foundationdb.cluster_description

    string
  • foundationdb.cluster_id

    string
  • foundationdb.port

    nullable integer
• hcaptcha

  nullable object
  Show child properties
  • hcaptcha.secret_fallback

    nullable string
  • hcaptcha.site_key_fallback

    nullable string
• ip_info

  nullable object
  Show child properties
  • ip_info.token

    string
• jwt

  object
  Show child properties
  • jwt.private

    string
  • jwt.public

    string

    The public EdDSA key in a PEM format.

• linode

  nullable object
  Show child properties
  • linode.api_token

    string
• loops

  nullable object
  Show child properties
  • loops.token

    string
• nats

  nullable object
  Show child properties
  • nats.addresses

    object
    Show possible variants
    • Variant #1
      • nats.addresses.dynamic

        object
        Show child properties
        • nats.addresses.dynamic.fetch_endpoint

          string
    • Variant #2
      • nats.addresses.static

        array of strings
  • nats.password

    nullable string
  • nats.port

    nullable integer
  • nats.username

    nullable string
• neon

  nullable object
  Show child properties
  • neon.api_key

    string
• nomad

  nullable object
  Show child properties
  • nomad.server_count

    integer
  • nomad.url

    string
• prometheus

  nullable object
  Show child properties
  • prometheus.url

    string
• redis

  nullable object
  Show child properties
  • redis.ephemeral

    object
    Show child properties
    • redis.ephemeral.password

      nullable string
    • redis.ephemeral.url

      string
    • redis.ephemeral.username

      nullable string
  • redis.persistent

    object
    Show child properties
    • redis.persistent.password

      nullable string
    • redis.persistent.url

      string
    • redis.persistent.username

      nullable string
• rivet

  nullable object
  Show child properties
  • rivet.api_edge

    nullable object

    Configuration for the edge API service.

    Show child properties
    • rivet.api_edge.host

      nullable string
    • rivet.api_edge.port

      nullable integer
    • rivet.api_edge.traefik_provider_token

      nullable string
  • rivet.api_public

    nullable object

    Configuration for the public API service.

    Show child properties
    • rivet.api_public.host

      nullable string

      The host on which the API service listens.

    • rivet.api_public.port

      nullable integer

      The port on which the API service listens.

    • rivet.api_public.public_origin

      nullable string

      The public origin URL for the API.

    • rivet.api_public.respect_forwarded_for

      nullable boolean

      Flag to respect the X-Forwarded-For header for client IP addresses.

      Will be ignored in favor of CF-Connecting-IP if DNS provider is configured as Cloudflare.

    • rivet.api_public.verbose_errors

      nullable boolean

      Flag to enable verbose error reporting.

  • rivet.auth

    nullable object

    Configuration for authentication and access control.

    Show child properties
    • rivet.auth.access_kind

      string
      Show possible variants
      • public

        Anyone can sign up for an account.

      • private

        Only admin users can create teams & projects.

      • development

        Anyone can access the cluster without authorization.

        If enabled: - A default project with slug "default" & environment with slug "default" will be created automatically - This allows using Rivet without manually creating a new project/environment - Project & environment fields will fallback to "default" if not provided - This allows using Rivet with simplified requests, like POST /actors without a query - If no bearer token is provided, authentication will always succeed - This allows setting up development environments without manually creating tokens

  • rivet.backend

    nullable object

    Configuration for backend features (Enterprise Edition).

    Show child properties
    • rivet.backend.base_domain

      string

      Base domain serving the backend endpoints.

  • rivet.billing

    nullable object

    Configuration for billing features (Enterprise Edition).

    Show child properties
    • rivet.billing.indie_price_id

      string

      Price ID for the indie tier.

    • rivet.billing.studio_price_id

      string

      Price ID for the studio tier.

  • rivet.cache

    nullable object

    Configuration for the cache layer.

    Show child properties
    • rivet.cache.driver

      string
      Show possible variants
      • redis
      • in_memory
  • rivet.cdn

    nullable empty object

    Deprecated: Configuration for CDN.

  • rivet.clusters

    nullable map
    Show child properties
    • rivet.clusters[key].bootstrap_datacenters

      map

      Datacenters to automatically be created on cluster boot.

      This should only be used for manual cluster creation. Do not use for enterprise distributions.

      Show child properties
      • rivet.clusters[key].bootstrap_datacenters[key].build_delivery_method

        string
        Show possible variants
        • traffic_server
        • s3_direct
      • rivet.clusters[key].bootstrap_datacenters[key].guard

        nullable object
        Show child properties
        • rivet.clusters[key].bootstrap_datacenters[key].guard.public_hostname

          nullable object
          Show possible variants
          • Variant #1
            • rivet.clusters[key].bootstrap_datacenters[key].guard.public_hostname.dns_parent

              string
          • Variant #2
            • rivet.clusters[key].bootstrap_datacenters[key].guard.public_hostname.static

              string
      • rivet.clusters[key].bootstrap_datacenters[key].hardware

        nullable object
        Show child properties
        • rivet.clusters[key].bootstrap_datacenters[key].hardware.bandwidth

          integer

          Kibps.

        • rivet.clusters[key].bootstrap_datacenters[key].hardware.cpu

          integer

          Mhz.

        • rivet.clusters[key].bootstrap_datacenters[key].hardware.cpu_cores

          integer
        • rivet.clusters[key].bootstrap_datacenters[key].hardware.disk

          integer

          MiB.

        • rivet.clusters[key].bootstrap_datacenters[key].hardware.memory

          integer

          MiB.

      • rivet.clusters[key].bootstrap_datacenters[key].id

        string

        This ID must not change.

      • rivet.clusters[key].bootstrap_datacenters[key].name

        string
    • rivet.clusters[key].id

      string

      This ID must not change.

  • rivet.default_cluster_id

    nullable string

    If specified, will use this as the default cluster ID.

    This will have no effect if applied after the cluster has first ran.

  • rivet.dns

    nullable object

    Configuration for DNS management.

    Show child properties
    • rivet.dns.domain_cdn

      nullable string

      The domain used for CDN-related services.

    • rivet.dns.domain_job

      nullable string

      The domain used for job-related services.

    • rivet.dns.domain_main

      nullable string

      The domain used for backend services.

    • rivet.dns.provider

      string
      Show possible variants
      • cloudflare
  • rivet.edge

    nullable object

    Configuration for edge clusters.

    Show child properties
    • rivet.edge.api_lan_address

      nullable array of unknowns

      This API address will be used if there are no worker servers listed in the cluster package

    • rivet.edge.cluster_id

      string
    • rivet.edge.datacenter_id

      string
    • rivet.edge.intercom_endpoint

      string
    • rivet.edge.redirect_logs_dir

      nullable string
    • rivet.edge.server_id

      string
  • rivet.guard

    nullable object

    The port ranges define what ports Guard will allocate ports on. If using cluster provisioning, these are also used for firewall rules.

    Show child properties
    • rivet.guard.http_port

      nullable integer
    • rivet.guard.https_port

      nullable integer
    • rivet.guard.max_ingress_port_tcp

      nullable integer
    • rivet.guard.max_ingress_port_udp

      nullable integer
    • rivet.guard.min_ingress_port_tcp

      nullable integer
    • rivet.guard.min_ingress_port_udp

      nullable integer
    • rivet.guard.tls_enabled

      nullable boolean
  • rivet.health

    nullable object

    Configuration for the health check service.

    Show child properties
    • rivet.health.host

      nullable string
    • rivet.health.port

      nullable integer
  • rivet.instance_id

    nullable string

    If specified, will use this as the default cluster ID.

    This will have no effect if applied after the cluster has first ran.

  • rivet.job_run

    nullable object

    Deprecated: Configuration for job running.

    Show child properties
    • rivet.job_run.job_runner_binary_url

      string
  • rivet.metrics

    nullable object

    Configuration for the metrics service.

    Show child properties
    • rivet.metrics.host

      nullable string
    • rivet.metrics.port

      nullable integer
  • rivet.namespace

    nullable string

    IMPORTANT: Do not change this value after the first time starting a cluster with this namespace.

  • rivet.orchestrator

    nullable object

    The service that manages Rivet Actors.

    Show child properties
    • rivet.orchestrator.host

      nullable string

      The host on which the Pegboard service listens.

    • rivet.orchestrator.port

      nullable integer

      The port on which the Pegboard service listens.

  • rivet.provision

    nullable object
    Show child properties
    • rivet.provision.container_runner_binary_url

      string

      The URL for the container runner binary.

    • rivet.provision.edge_server_binary_url

      string
    • rivet.provision.guard_binary_url

      string
    • rivet.provision.isolate_runner_binary_url

      string

      The URL for the isolate runner binary.

    • rivet.provision.manager_binary_url

      string

      The URL for the manager binary.

    • rivet.provision.pools

      object
      Show child properties
      • rivet.provision.pools.ats

        object
        Show child properties
        • rivet.provision.pools.ats.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.ats.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.ats.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.ats.firewall_rules[].label

            string
          • rivet.provision.pools.ats.firewall_rules[].ports

            string
          • rivet.provision.pools.ats.firewall_rules[].protocol

            string
        • rivet.provision.pools.ats.vlan_ip_net

          nullable string
      • rivet.provision.pools.fdb

        object
        Show child properties
        • rivet.provision.pools.fdb.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.fdb.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.fdb.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.fdb.firewall_rules[].label

            string
          • rivet.provision.pools.fdb.firewall_rules[].ports

            string
          • rivet.provision.pools.fdb.firewall_rules[].protocol

            string
        • rivet.provision.pools.fdb.vlan_ip_net

          nullable string
      • rivet.provision.pools.gg

        object
        Show child properties
        • rivet.provision.pools.gg.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.gg.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.gg.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.gg.firewall_rules[].label

            string
          • rivet.provision.pools.gg.firewall_rules[].ports

            string
          • rivet.provision.pools.gg.firewall_rules[].protocol

            string
        • rivet.provision.pools.gg.vlan_ip_net

          nullable string
      • rivet.provision.pools.guard

        object
        Show child properties
        • rivet.provision.pools.guard.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.guard.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.guard.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.guard.firewall_rules[].label

            string
          • rivet.provision.pools.guard.firewall_rules[].ports

            string
          • rivet.provision.pools.guard.firewall_rules[].protocol

            string
        • rivet.provision.pools.guard.vlan_ip_net

          nullable string
      • rivet.provision.pools.job

        empty object
      • rivet.provision.pools.nats

        object
        Show child properties
        • rivet.provision.pools.nats.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.nats.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.nats.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.nats.firewall_rules[].label

            string
          • rivet.provision.pools.nats.firewall_rules[].ports

            string
          • rivet.provision.pools.nats.firewall_rules[].protocol

            string
        • rivet.provision.pools.nats.vlan_ip_net

          nullable string
      • rivet.provision.pools.pegboard

        object

        These port range values will be pass to the Rivet Clients to choose ports & are used to provision firewalls.

        Show child properties
        • rivet.provision.pools.pegboard.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.pegboard.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.pegboard.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.pegboard.firewall_rules[].label

            string
          • rivet.provision.pools.pegboard.firewall_rules[].ports

            string
          • rivet.provision.pools.pegboard.firewall_rules[].protocol

            string
        • rivet.provision.pools.pegboard.max_lan_port

          nullable integer
        • rivet.provision.pools.pegboard.max_wan_port

          nullable integer
        • rivet.provision.pools.pegboard.min_lan_port

          nullable integer
        • rivet.provision.pools.pegboard.min_wan_port

          nullable integer
        • rivet.provision.pools.pegboard.vlan_addr_range_max

          nullable string
        • rivet.provision.pools.pegboard.vlan_addr_range_min

          nullable string
      • rivet.provision.pools.worker

        object
        Show child properties
        • rivet.provision.pools.worker.firewall_rules

          nullable array of objects
          Show child properties
          • rivet.provision.pools.worker.firewall_rules[].inbound_ipv4_cidr

            array of strings
          • rivet.provision.pools.worker.firewall_rules[].inbound_ipv6_cidr

            array of strings
          • rivet.provision.pools.worker.firewall_rules[].label

            string
          • rivet.provision.pools.worker.firewall_rules[].ports

            string
          • rivet.provision.pools.worker.firewall_rules[].protocol

            string
        • rivet.provision.pools.worker.vlan_ip_net

          nullable string
    • rivet.provision.vlan_ip_net

      nullable string
  • rivet.status

    nullable object

    Configure the status check API.

    These are different than the health check API since they check the internals of the Rivet system.

    Show child properties
    • rivet.status.system_test_environment

      nullable string
    • rivet.status.system_test_project

      nullable string
    • rivet.status.token

      string
  • rivet.telemetry

    nullable object

    Configuration for telemetry collection.

    Show child properties
    • rivet.telemetry.enable

      boolean

      Flag to enable or disable telemetry collection.

  • rivet.test_builds

    nullable map

    Configuration for test builds.

    Show child properties
    • rivet.test_builds[key].key

      string

      S3 key.

    • rivet.test_builds[key].tag

      string

      Image tag.

  • rivet.tunnel

    nullable object

    Configuration for the tunnel service.

    Show child properties
    • rivet.tunnel.public_host

      string
  • rivet.ui

    nullable object

    Configuration for the UI service.

    Show child properties
    • rivet.ui.enable

      nullable boolean

      Enables serving the UI automatically.

      If disabled, the UI can be hosted separately.

    • rivet.ui.public_origin

      nullable string

      The origin URL for the UI.

    • rivet.ui.public_origin_regex

      nullable string

      Regular expression to match valid UI origins.

• s3

  nullable object
  Show child properties
  • s3.access_key_id

    string
  • s3.endpoint_edge_internal

    nullable string

    If not defined, will default to endpoint_external.

  • s3.endpoint_external

    string
  • s3.endpoint_internal

    string
  • s3.region

    string
  • s3.secret_access_key

    string
• sendgrid

  nullable object
  Show child properties
  • sendgrid.key

    string
• ssh

  nullable object
  Show child properties
  • ssh.server

    object
    Show child properties
    • ssh.server.private_key_openssh

      string
• stripe

  nullable object
  Show child properties
  • stripe.secret_key

    string
  • stripe.webhook_secret

    string
• tls

  nullable object
  Show child properties
  • tls.acme

    object
    Show child properties
    • tls.acme.account_private_key_pem

      string
    • tls.acme.directory

      nullable string
      Show possible variants
      • lets_encrypt
      • lets_encrypt_staging
  • tls.root_ca_cert_pem

    string
  • tls.root_ca_key_pem

    string
• turnstile

  nullable object
  Show child properties
  • turnstile.cdn_secret_key

    nullable string
  • turnstile.cdn_site_key

    nullable string
  • turnstile.main_secret_key

    nullable string
  • turnstile.main_site_key

    nullable string
• vector_http

  nullable object
  Show child properties
  • vector_http.host

    string
  • vector_http.port

    integer