Client Config

Client

• cluster

  object
  Show child properties
  • cluster.api_endpoint

    string
  • cluster.client_id

    string
  • cluster.ws_addresses

    object
    Show possible variants
    • Variant #1
      • cluster.ws_addresses.dynamic

        object
        Show child properties
        • cluster.ws_addresses.dynamic.fetch_endpoint

          string
    • Variant #2
      • cluster.ws_addresses.static

        array of strings
• cni

  nullable object
  Show child properties
  • cni.bin_path

    nullable string
  • cni.config_path

    nullable string
  • cni.network_interface

    string
  • cni.network_name

    nullable string
• data_dir

  nullable string
• foundationdb

  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
• images

  nullable object
  Show child properties
  • images.pull_addresses

    nullable object
    Show possible variants
    • Variant #1
      • images.pull_addresses.dynamic

        object
        Show child properties
        • images.pull_addresses.dynamic.fetch_endpoint

          string
    • Variant #2
      • images.pull_addresses.static

        array of strings
• logs

  nullable object
  Show child properties
  • logs.redirect_logs

    nullable boolean
  • logs.retention

    nullable integer

    Log retention in seconds. Defaults to 10 days. Only applies with log redirection enabled.

• metrics

  nullable object
  Show child properties
  • metrics.port

    nullable integer
• network

  object
  Show child properties
  • network.bind_ip

    string

    Address to serve actor traffic on.

    This will usually be the same as actor_lan_ip unless the node is accessed within the LAN by a different IP.

  • network.lan_hostname

    string

    Address to access this node in a LAN.

    This IP is used to route traffic from Game Guard.

  • network.lan_port_range_max

    nullable integer
  • network.lan_port_range_min

    nullable integer
  • network.wan_hostname

    string

    Address to access this node publicly.

    This IP is used when providing the actor's IP & port for host networking.

  • network.wan_port_range_max

    nullable integer
  • network.wan_port_range_min

    nullable integer
• reserved_resources

  nullable object
  Show child properties
  • reserved_resources.cpu

    nullable integer
  • reserved_resources.memory

    nullable integer
• runner

  object
  Show child properties
  • runner.container_runner_binary_path

    nullable string
  • runner.flavor

    string
    Show possible variants
    • container
    • isolate
  • runner.isolate_runner_binary_path

    nullable string
  • runner.port

    nullable integer

    WebSocket Port for runners on this machine to connect to.

  • runner.use_mounts

    nullable boolean

    Whether or not to use a mount for actor file systems.

• vector

  nullable object
  Show child properties
  • vector.address

    string