rust_bifrost/doc/config-reference.md

## Configuration reference

Bifrost

```yaml
# Bifrost section [optional!]
#
# Contains bifrost server settings
# [usually omitted, to use defaults]
bifrost:
  # name of yaml file to write state database to
  state_file: "state.yaml"

  # name of x509 certificate for https
  #
  # if this file is missing, bifrost will generate one for you
  #
  # if this file exists, bifrost will check that the mac address
  # matches the specified server mac address
  #
  # to generate a fresh certificate, rename/move this file
  # (this might require pairing the Hue App again)
  cert_file: "cert.pem"

# Bridge section
#
# Settings for hue bridge emulation
bridge:
  name: Bifrost
  mac: 00:11:22:33:44:55
  ipaddress: 10.0.0.12
  netmask: 255.255.255.0
  gateway: 10.0.0.1
  timezone: Europe/Copenhagen

  # HTTP port for emulated bridge
  #
  # beware: most client programs do NOT support non-standard ports.
  # This is for advanced users (e.g. bifrost behind a reverse proxy)
  http_port: 80

  # HTTPS port for emulated bridge
  #
  # beware: most client programs do NOT support non-standard ports.
  # This is for advanced users (e.g. bifrost behind a reverse proxy)
  https_port: 443

  # DTLS port for emulated bridge (Hue Entertainment streaming)
  #
  # beware: client programs do NOT support non-standard ports.
  # For advanced users (e.g. bifrost behind a port forwarded firewall)
  entm_port: 2100

# Zigbee2mqtt section
#
# Make a sub-section for each zigbee2mqtt server you want to connect
#
# The server names ("some-server", "other-with-tls") are used for logging,
# but have no functional impact.
#
# NOTE: Be sure to use DIFFERENT names for different servers.
# Otherwise the yaml parser will consider it the same server!
z2m:
  some-server:
    # The websocket url for z2m, starting with "ws://".
    #
    # For z2m version 2.x, the url must end in `/api?token=<token>`.
    # For z2m version 1.x, this is optional, but supported.
    #
    # Therefore, Bifrost will adjust the urls if needed.
    # A message will be logged with the rewritten url if this happens.
    #
    # NOTE: The z2m default token is literally the string "your-secret-token",
    # so if unsure, append "/api?token=your-secret-token".
    #
    # Example:
    #
    #   If your z2m frontend is listening on 10.00.0.100:8080, this
    #   is the resuling config:
    #
    url: ws://10.00.0.100:8080/api?token=your-secret-token

  other-with-tls:
    # This will work, but Bifrost will generate a warning that the url has been
    # adapted to include "/api?token=your-secret-token".
    #
    # NOTE: Using "wss://" instead of "ws://" enables TLS for this connection.
    url: wss://10.10.0.102:8080

    # Disable TLS verify [optional!]
    #
    # If this parameter is included, and has a value of "true", TLS certificate
    # verification will be disabled!
    #
    # NOTE: From a security standpoint, this is almost as bad as disabling
    # encryption entirely. If having a secure connection is important to you,
    # DO NOT enable this option.
    #
    # If you're using self-signed certificates, enabling this option will allow
    # Bifrost to connect to your z2m server.
    disable_tls_verify: false

    # Group prefix [optional!]
    #
    # If you specify this parameter, *only* groups with this prefix
    # will be visible from this z2m server. The prefix will be removed.
    #
    # Example:
    #
    #   With a group_prefix of "bifrost_", the group "bifrost_kitchen"
    #   will be available as "kitchen", but the group "living_room" will
    #   be hidden instead.
    #
    group_prefix: bifrost_

    # Streaming mode ("Entertainment mode" / "Hue Sync") maximum frames per second
    # [optional!]
    #
    # This is the maximum number of light updates attempted per second.
    #
    # The incoming data stream (from a Sync Box, Hue Sync for Windows/Mac,
    # or some other client) determines the maximum possible fps.
    #
    # For example, if Bifrost only receives light updates at 10 fps, setting
    # this limit to 20 will still only cause the lights to update at 10 fps.
    #
    # On the other hand, if the streaming client sends faster than this limit,
    # frames will be dropped to avoid going over it.
    #
    # If not specified, uses a default of 20, which is an attempt to balance
    # responsiveness against load on the Zigbee mesh.
    #
    # Because of the smoothing algorithm Bifrost uses, the results will look
    # *better* if this is not set higher than needed.
    #
    # For example, 30 fps content will look good at 10, 20 or 30 streaming_fps,
    # but worse at streaming_fps: 60, because the frame-to-frame transition
    # time will be wrong for the content.
    #
    # Rules of thumb(s), for best results:
    # - Higher numbers mean greater load on your Zigbee mesh.
    # - If your mesh starts lagging or becoming unresponsive, try a lower number.
    # - Even values as low as 5 fps looks pretty good.
    # - There usually no reason to go above 60.
    # - Have fun experimenting :-)
    streaming_fps: 20
  ...

# Rooms section [optional!]
#
# This section allows you to map zigbee2mqtt "friendly names" to
# a human-readable description you provide.
#
# Each entry under "rooms" must match a zigbee2mqtt "friendly name",
# and can contain the following keys: (both are optional)
#
#   name: The human-readable name presented in the API (for the Hue App, etc)
#
#   icon: The icon to use for this room. Must be selected from the following
#         list of icons supported by the Hue App:
#
#         attic balcony barbecue bathroom bedroom carport closet computer dining
#         downstairs driveway front_door garage garden guest_room gym hallway
#         home kids_bedroom kitchen laundry_room living_room lounge man_cave
#         music nursery office other pool porch reading recreation staircase
#         storage studio terrace toilet top_floor tv upstairs
#
rooms:
  office_group:
    name: Office 1
    icon: office

  carport_group:
    name: Carport Lights
    icon: carport

  ...
```