Version: v3

Configuration

Neko uses the Viper library to manage configuration. The configuration file is optional and is not required for Neko to run. If a configuration file is present, it will be read in and merged with the default configuration values.

The merge order is as follows:

Default configuration values
Configuration file
Environment variables
Command-line arguments

Example merging order

# Default Value: 127.0.0.1:8080

# Config File
cat config.yaml <<EOF
server:
  bind: "127.0.0.1:8081"
EOF

# Environment Variable
export NEKO_SERVER_BIND=127.0.0.1:8082

# Command-line Argument
./neko -config=config.yaml -server.bind=127.0.0.1:8083

The final value of server.bind will be 127.0.0.1:8083.

Configuration File

You have multiple ways to specify the configuration file for the neko server:

Command-line argument: -config=/path/to/config.yaml
Environment variable: NEKO_CONFIG=/path/to/config.yaml
Place the neko.yaml file in the same directory as the neko binary.
Place the neko.yaml file to /etc/neko/neko.yaml (ideal for Docker containers).

The configuration file can be specified in YAML, JSON, TOML, HCL, envfile, and Java properties format. Throughout the documentation, we will use the YAML format.

Example configuration files

config.yaml
capture:
  screencast:
    enabled: false

server:
  pprof: true

desktop:
  screen: "1920x1080@60"

member:
  provider: "multiuser"
  multiuser:
  admin_password: "admin"
  user_password: "neko"

session:
  merciful_reconnect: true
  implicit_hosting: false
  inactive_cursors: true
  cookie:
    enabled: false

webrtc:
  icelite: true
  iceservers:
    # Backend servers are ignored if icelite is true.
    backend:
      - urls: [ stun:stun.l.google.com:19302 ]
    frontend:
      - urls: [ stun:stun.l.google.com:19305 ]

config.json
{
  "capture": {
    "screencast": {
      "enabled": false
    }
  },
  "server": {
    "pprof": true
  },
  "desktop": {
    "screen": "1920x1080@60"
  },
  "member": {
    "provider": "multiuser",
    "multiuser": {
      "admin_password": "admin",
      "user_password": "neko"
    }
  },
  "session": {
    "merciful_reconnect": true,
    "implicit_hosting": false,
    "inactive_cursors": true,
    "cookie": {
      "enabled": false
    }
  },
  "webrtc": {
    "icelite": true,
    "iceservers": {
      "backend": [
        {
          "urls": [ "stun:stun.l.google.com:19302" ]
        }
      ],
      "frontend": [
        {
          "urls": [ "stun:stun.l.google.com:19305" ]
        }
      ]
    }
  }
}

config.toml
[capture.screencast]
enabled = false

[server]
pprof = true

[desktop]
screen = "1920x1080@60"

[member]
provider = "multiuser"

[member.multiuser]
admin_password = "admin"
user_password = "neko"

[session]
merciful_reconnect = true
implicit_hosting = false
inactive_cursors = true

[session.cookie]
enabled = false

[webrtc]
icelite = true

[[webrtc.iceservers.backend]]
urls = [ "stun:stun.l.google.com:19302" ]

[[webrtc.iceservers.frontend]]
urls = [ "stun:stun.l.google.com:19305" ]

config.hcl
capture {
  screencast {
    enabled = false
  }
}

server {
  pprof = true
}

desktop {
  screen = "1920x1080@60"
}

member {
  provider = "multiuser"

  multiuser {
    admin_password = "admin"
    user_password = "neko"
  }
}

session {
  merciful_reconnect = true
  implicit_hosting = false
  inactive_cursors = true

  cookie {
    enabled = false
  }
}

webrtc {
  icelite = true

  iceservers {
    backend {
      urls = [ "stun:stun.l.google.com:19302" ]
    }

    frontend {
      urls = [ "stun:stun.l.google.com:19305" ]
    }
  }
}

.env
CAPTURE_SCREENCAST_ENABLED=false

SERVER_PPROF=true

DESKTOP_SCREEN=1920x1080@60

MEMBER_PROVIDER=multiuser
MEMBER_MULTIUSER_ADMIN_PASSWORD=admin
MEMBER_MULTIUSER_USER_PASSWORD=neko

SESSION_MERCIFUL_RECONNECT=true
SESSION_IMPLICIT_HOSTING=false
SESSION_INACTIVE_CURSORS=true
SESSION_COOKIE_ENABLED=false

WEBRTC_ICELITE=true

WEBRTC_ICESERVERS_BACKEND="[{"urls":["stun:stun.l.google.com:19302"]}]"
WEBRTC_ICESERVERS_FRONTEND="[{"urls":["stun:stun.l.google.com:19305"]}]"

config.properties
capture.screencast.enabled = false

server.pprof = true

desktop.screen = 1920x1080@60

member.provider = multiuser
member.multiuser.admin_password = admin
member.multiuser.user_password = neko

session.merciful_reconnect = true
session.implicit_hosting = false
session.inactive_cursors = true
session.cookie.enabled = false

webrtc.icelite = true

webrtc.iceservers.backend[0].urls[0] = stun:stun.l.google.com:19302
webrtc.iceservers.frontend[0].urls[0] = stun:stun.l.google.com:19305

Room Configuration

This is the initial configuration of the room that can be modified by an admin in real-time.

config.yaml
session:
  private_mode: false
  locked_logins: false
  locked_controls: false
  control_protection: false
  implicit_hosting: true
  inactive_cursors: false
  merciful_reconnect: true
  heartbeat_interval: 120

private_mode whether private mode is enabled, users do not receive the room video or audio.
locked_logins whether logins are locked for users, admins can still login.
locked_controls whether controls are locked for users, admins can still control.
control_protection users can gain control only if at least one admin is in the room.
implicit_hosting allows switching control implicitly without the need for explicit control request before
inactive_cursors whether to show inactive cursors server-wide (only for users that have it enabled in their profile)
merciful_reconnect whether to allow reconnecting to the websocket even if the previous connection was not closed. This means that a new login can kick out the previous one.
heartbeat_interval interval in seconds for sending a heartbeat message to the server. This is used to keep the connection alive and to detect when the connection is lost.

Server Configuration

This is the configuration of the neko server.

config.yaml
server:
  bind: "127.0.0.1:8080"
  cert: "/path/to/cert.pem"
  key: "/path/to/key.pem"
  cors: [ "*" ]
  metrics: true
  path_prefix: "/neko"
  pprof: true
  proxy: true
  static: "/var/www/neko"

bind address/port/socket to serve neko. For docker you might want to bind to 0.0.0.0 to allow connections from outside the container.
cert and key paths to the SSL cert and key used to secure the neko server. If both are empty, the server will run in plain HTTP.
cors is a list of allowed origins for CORS.
- If empty, CORS is disabled, and only same-origin requests are allowed.
- If * is present, all origins are allowed. Neko will respond always with the requested origin, not with * since credentials are not allowed with wildcard.
- If a list of origins is present, only those origins are allowed for CORS.
metrics when true, prometheus metrics are available at /metrics.
path_prefix is the prefix for all HTTP requests. This is useful when running neko behind a reverse proxy and you want to serve neko under a subpath, e.g. /neko.
pprof when true, the pprof endpoint is available at /debug/pprof for debugging and profiling. This should be disabled in production.
proxy when true, neko will trust the X-Forwarded-For and X-Real-IP headers from the reverse proxy. Make sure your reverse proxy is configured to set these headers and never trust them when not behind a reverse proxy. See Reverse Proxy Setup for more information.
static path to the directory containing the neko client files to serve. This is useful if you want to serve the client files on the same domain as the server.

Logging Configuration

This is the configuration of the logging system.

config.yaml
log:
  dir: <string>
  json: true
  level: "info"
  nocolor: true
  time: "unix"

dir directory to store logs. If empty, logs are written to stdout. This is useful when running neko in a container.
json when true, logs are written in JSON format.
level log level to set. Available levels are trace, debug, info, warn, error, fatal, panic, and disabled.
nocolor when true, ANSI colors are disabled in non-JSON output. Accepts as well NO_COLOR environment variable.
time time format used in logs. Available formats are unix, unixms, and unixmicro.

tip

Shortcut environment variable to enable DEBUG mode: NEKO_DEBUG=true

Full Configuration Reference

Here is a full configuration with default values as shown in the help command. Please refer to the sub-sections for more details.

Environment Variables
Command Line Arguments
YAML Configuration File

You can set the following environment variables in your docker-compose.yaml file or in your shell environment.

# audio codec to be used
NEKO_CAPTURE_AUDIO_CODEC: "opus"
# pulseaudio device to capture
NEKO_CAPTURE_AUDIO_DEVICE: "audio_output.monitor"
# gstreamer pipeline used for audio streaming
NEKO_CAPTURE_AUDIO_PIPELINE: <string>
# broadcast audio bitrate in KB/s
NEKO_CAPTURE_BROADCAST_AUDIO_BITRATE: "128"
# automatically start broadcasting when neko starts and broadcast_url is set
NEKO_CAPTURE_BROADCAST_AUTOSTART: "true"
# gstreamer pipeline used for broadcasting
NEKO_CAPTURE_BROADCAST_PIPELINE: <string>
# broadcast speed preset for h264 encoding
NEKO_CAPTURE_BROADCAST_PRESET: "veryfast"
# initial URL for broadcasting, setting this value will automatically start broadcasting
NEKO_CAPTURE_BROADCAST_URL: <string>
# broadcast video bitrate in KB/s
NEKO_CAPTURE_BROADCAST_VIDEO_BITRATE: "4096"
# pulseaudio device used for microphone
NEKO_CAPTURE_MICROPHONE_DEVICE: "audio_input"
# enable microphone stream
NEKO_CAPTURE_MICROPHONE_ENABLED: "true"
# enable screencast
NEKO_CAPTURE_SCREENCAST_ENABLED: "false"
# gstreamer pipeline used for screencasting
NEKO_CAPTURE_SCREENCAST_PIPELINE: <string>
# screencast JPEG quality
NEKO_CAPTURE_SCREENCAST_QUALITY: "60"
# screencast frame rate
NEKO_CAPTURE_SCREENCAST_RATE: "10/1"
# video codec to be used
NEKO_CAPTURE_VIDEO_CODEC: "vp8"
# X display to capture
NEKO_CAPTURE_VIDEO_DISPLAY: <string>
# ordered list of video ids
NEKO_CAPTURE_VIDEO_IDS: <strings>
# pipelines config in JSON used for video streaming
NEKO_CAPTURE_VIDEO_PIPELINES: "[]"
# v4l2sink device used for webcam
NEKO_CAPTURE_WEBCAM_DEVICE: "/dev/video0"
# enable webcam stream
NEKO_CAPTURE_WEBCAM_ENABLED: "false"
# webcam stream height
NEKO_CAPTURE_WEBCAM_HEIGHT: "720"
# webcam stream width
NEKO_CAPTURE_WEBCAM_WIDTH: "1280"
# X display to use for desktop sharing
NEKO_DESKTOP_DISPLAY: <string>
# whether to handle file chooser dialog externally
NEKO_DESKTOP_FILE_CHOOSER_DIALOG: "false"
# whether custom xf86 input driver should be used to handle touchscreen
NEKO_DESKTOP_INPUT_ENABLED: "true"
# socket path for custom xf86 input driver connection
NEKO_DESKTOP_INPUT_SOCKET: "/tmp/xf86-input-neko.sock"
# default screen size and framerate
NEKO_DESKTOP_SCREEN: "1280x720@30"
# automatically unminimize window when it is minimized
NEKO_DESKTOP_UNMINIMIZE: "true"
# whether drop upload is enabled
NEKO_DESKTOP_UPLOAD_DROP: "true"
# member file provider: whether to hash passwords using sha256 (recommended)
NEKO_MEMBER_FILE_HASH: "true"
# member file provider: storage path
NEKO_MEMBER_FILE_PATH: <string>
# member multiuser provider: admin password
NEKO_MEMBER_MULTIUSER_ADMIN_PASSWORD: "admin"
# member multiuser provider: admin profile in JSON format
NEKO_MEMBER_MULTIUSER_ADMIN_PROFILE: "{}"
# member multiuser provider: user password
NEKO_MEMBER_MULTIUSER_USER_PASSWORD: "neko"
# member multiuser provider: user profile in JSON format
NEKO_MEMBER_MULTIUSER_USER_PROFILE: "{}"
# member object provider: users in JSON format
NEKO_MEMBER_OBJECT_USERS: "[]"
# choose member provider
NEKO_MEMBER_PROVIDER: "multiuser"
# path to neko plugins to load
NEKO_PLUGINS_DIR: "./bin/plugins"
# load plugins in runtime
NEKO_PLUGINS_ENABLED: "false"
# if true, neko will exit if there is an error when loading a plugin
NEKO_PLUGINS_REQUIRED: "false"
# address/port/socket to serve neko
NEKO_SERVER_BIND: "127.0.0.1:8080"
# path to the SSL cert used to secure the neko server
NEKO_SERVER_CERT: <string>
# list of allowed origins for CORS, if empty CORS is disabled, if '*' is present all origins are allowed
NEKO_SERVER_CORS: <strings>
# path to the SSL key used to secure the neko server
NEKO_SERVER_KEY: <string>
# enable prometheus metrics available at /metrics
NEKO_SERVER_METRICS: "true"
# path prefix for HTTP requests
NEKO_SERVER_PATH_PREFIX: "/"
# enable pprof endpoint available at /debug/pprof
NEKO_SERVER_PPROF: "false"
# trust reverse proxy headers
NEKO_SERVER_PROXY: "false"
# path to neko client files to serve
NEKO_SERVER_STATIC: <string>
# API token for interacting with external services
NEKO_SESSION_API_TOKEN: <string>
# users can gain control only if at least one admin is in the room
NEKO_SESSION_CONTROL_PROTECTION: "false"
# domain of the cookie
NEKO_SESSION_COOKIE_DOMAIN: <string>
# whether cookies authentication should be enabled
NEKO_SESSION_COOKIE_ENABLED: "true"
# expiration of the cookie
NEKO_SESSION_COOKIE_EXPIRATION: "24h0m0s"
# use http only cookies
NEKO_SESSION_COOKIE_HTTP_ONLY: "true"
# name of the cookie that holds token
NEKO_SESSION_COOKIE_NAME: "NEKO_SESSION"
# path of the cookie
NEKO_SESSION_COOKIE_PATH: <string>
# use secure cookies
NEKO_SESSION_COOKIE_SECURE: "true"
# if sessions should be stored in a file, otherwise they will be stored only in memory
NEKO_SESSION_FILE: <string>
# interval in seconds for sending heartbeat messages
NEKO_SESSION_HEARTBEAT_INTERVAL: "120"
# allow implicit control switching
NEKO_SESSION_IMPLICIT_HOSTING: "true"
# show inactive cursors on the screen
NEKO_SESSION_INACTIVE_CURSORS: "false"
# whether controls should be locked for users initially
NEKO_SESSION_LOCKED_CONTROLS: "false"
# whether logins should be locked for users initially
NEKO_SESSION_LOCKED_LOGINS: "false"
# allow reconnecting to websocket even if previous connection was not closed
NEKO_SESSION_MERCIFUL_RECONNECT: "true"
# whether private mode should be enabled initially
NEKO_SESSION_PRIVATE_MODE: "false"
# limits the pool of ephemeral ports that ICE UDP connections can allocate from
NEKO_WEBRTC_EPR: <string>
# enables debug logging for the bandwidth estimator
NEKO_WEBRTC_ESTIMATOR_DEBUG: "false"
# how bigger the difference between estimated and stream bitrate must be to trigger upgrade/downgrade
NEKO_WEBRTC_ESTIMATOR_DIFF_THRESHOLD: "0.15"
# how long to wait before downgrading again after previous downgrade
NEKO_WEBRTC_ESTIMATOR_DOWNGRADE_BACKOFF: "10s"
# enables the bandwidth estimator
NEKO_WEBRTC_ESTIMATOR_ENABLED: "false"
# initial bitrate for the bandwidth estimator
NEKO_WEBRTC_ESTIMATOR_INITIAL_BITRATE: "1000000"
# passive estimator mode, when it does not switch pipelines, only estimates
NEKO_WEBRTC_ESTIMATOR_PASSIVE: "false"
# how often to read and process bandwidth estimation reports
NEKO_WEBRTC_ESTIMATOR_READ_INTERVAL: "2s"
# how long to wait for stable connection (upward or neutral trend) before upgrading
NEKO_WEBRTC_ESTIMATOR_STABLE_DURATION: "12s"
# how long to wait for stalled bandwidth estimation before downgrading
NEKO_WEBRTC_ESTIMATOR_STALLED_DURATION: "24s"
# how long to wait for stalled connection (neutral trend with low bandwidth) before downgrading
NEKO_WEBRTC_ESTIMATOR_UNSTABLE_DURATION: "6s"
# how long to wait before upgrading again after previous upgrade
NEKO_WEBRTC_ESTIMATOR_UPGRADE_BACKOFF: "5s"
# configures whether or not the ICE agent should be a lite agent
NEKO_WEBRTC_ICELITE: "false"
# Backend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
NEKO_WEBRTC_ICESERVERS_BACKEND: "[]"
# Frontend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
NEKO_WEBRTC_ICESERVERS_FRONTEND: "[]"
# configures whether cadidates should be sent asynchronously using Trickle ICE
NEKO_WEBRTC_ICETRICKLE: "true"
# URL address used for retrieval of the external IP address
NEKO_WEBRTC_IP_RETRIEVAL_URL: "https://checkip.amazonaws.com"
# sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used
NEKO_WEBRTC_NAT1TO1: <strings>
# single TCP mux port for all peers
NEKO_WEBRTC_TCPMUX: <int>
# single UDP mux port for all peers, replaces EPR
NEKO_WEBRTC_UDPMUX: <int>
# configuration file path
NEKO_CONFIG: <string>
# enable debug mode
NEKO_DEBUG: "false"
# logging directory to store logs
NEKO_LOG_DIR: <string>
# logs in JSON format
NEKO_LOG_JSON: "false"
# set log level (trace, debug, info, warn, error, fatal, panic, disabled)
NEKO_LOG_LEVEL: "info"
# no ANSI colors in non-JSON output
NEKO_LOG_NOCOLOR: "false"
# time format used in logs (unix, unixms, unixmicro)
NEKO_LOG_TIME: "unix"

You can list the following command line arguments using neko serve --help.

# audio codec to be used
--capture.audio.codec <string>
# pulseaudio device to capture
--capture.audio.device <string>
# gstreamer pipeline used for audio streaming
--capture.audio.pipeline <string>
# broadcast audio bitrate in KB/s
--capture.broadcast.audio_bitrate <int>
# automatically start broadcasting when neko starts and broadcast_url is set
--capture.broadcast.autostart <boolean>
# gstreamer pipeline used for broadcasting
--capture.broadcast.pipeline <string>
# broadcast speed preset for h264 encoding
--capture.broadcast.preset <string>
# initial URL for broadcasting, setting this value will automatically start broadcasting
--capture.broadcast.url <string>
# broadcast video bitrate in KB/s
--capture.broadcast.video_bitrate <int>
# pulseaudio device used for microphone
--capture.microphone.device <string>
# enable microphone stream
--capture.microphone.enabled <boolean>
# enable screencast
--capture.screencast.enabled <boolean>
# gstreamer pipeline used for screencasting
--capture.screencast.pipeline <string>
# screencast JPEG quality
--capture.screencast.quality <string>
# screencast frame rate
--capture.screencast.rate <string>
# video codec to be used
--capture.video.codec <string>
# X display to capture
--capture.video.display <string>
# ordered list of video ids
--capture.video.ids <strings>
# pipelines config in JSON used for video streaming
--capture.video.pipelines <string>
# v4l2sink device used for webcam
--capture.webcam.device <string>
# enable webcam stream
--capture.webcam.enabled <boolean>
# webcam stream height
--capture.webcam.height <int>
# webcam stream width
--capture.webcam.width <int>
# X display to use for desktop sharing
--desktop.display <string>
# whether to handle file chooser dialog externally
--desktop.file_chooser_dialog <boolean>
# whether custom xf86 input driver should be used to handle touchscreen
--desktop.input.enabled <boolean>
# socket path for custom xf86 input driver connection
--desktop.input.socket <string>
# default screen size and framerate
--desktop.screen <string>
# automatically unminimize window when it is minimized
--desktop.unminimize <boolean>
# whether drop upload is enabled
--desktop.upload_drop <boolean>
# member file provider: whether to hash passwords using sha256 (recommended)
--member.file.hash <boolean>
# member file provider: storage path
--member.file.path <string>
# member multiuser provider: admin password
--member.multiuser.admin_password <string>
# member multiuser provider: admin profile in JSON format
--member.multiuser.admin_profile <string>
# member multiuser provider: user password
--member.multiuser.user_password <string>
# member multiuser provider: user profile in JSON format
--member.multiuser.user_profile <string>
# member object provider: users in JSON format
--member.object.users <string>
# choose member provider
--member.provider <string>
# path to neko plugins to load
--plugins.dir <string>
# load plugins in runtime
--plugins.enabled <boolean>
# if true, neko will exit if there is an error when loading a plugin
--plugins.required <boolean>
# address/port/socket to serve neko
--server.bind <string>
# path to the SSL cert used to secure the neko server
--server.cert <string>
# list of allowed origins for CORS, if empty CORS is disabled, if '*' is present all origins are allowed
--server.cors <strings>
# path to the SSL key used to secure the neko server
--server.key <string>
# enable prometheus metrics available at /metrics
--server.metrics <boolean>
# path prefix for HTTP requests
--server.path_prefix <string>
# enable pprof endpoint available at /debug/pprof
--server.pprof <boolean>
# trust reverse proxy headers
--server.proxy <boolean>
# path to neko client files to serve
--server.static <string>
# API token for interacting with external services
--session.api_token <string>
# users can gain control only if at least one admin is in the room
--session.control_protection <boolean>
# domain of the cookie
--session.cookie.domain <string>
# whether cookies authentication should be enabled
--session.cookie.enabled <boolean>
# expiration of the cookie
--session.cookie.expiration <duration>
# use http only cookies
--session.cookie.http_only <boolean>
# name of the cookie that holds token
--session.cookie.name <string>
# path of the cookie
--session.cookie.path <string>
# use secure cookies
--session.cookie.secure <boolean>
# if sessions should be stored in a file, otherwise they will be stored only in memory
--session.file <string>
# interval in seconds for sending heartbeat messages
--session.heartbeat_interval <int>
# allow implicit control switching
--session.implicit_hosting <boolean>
# show inactive cursors on the screen
--session.inactive_cursors <boolean>
# whether controls should be locked for users initially
--session.locked_controls <boolean>
# whether logins should be locked for users initially
--session.locked_logins <boolean>
# allow reconnecting to websocket even if previous connection was not closed
--session.merciful_reconnect <boolean>
# whether private mode should be enabled initially
--session.private_mode <boolean>
# limits the pool of ephemeral ports that ICE UDP connections can allocate from
--webrtc.epr <string>
# enables debug logging for the bandwidth estimator
--webrtc.estimator.debug <boolean>
# how bigger the difference between estimated and stream bitrate must be to trigger upgrade/downgrade
--webrtc.estimator.diff_threshold <float>
# how long to wait before downgrading again after previous downgrade
--webrtc.estimator.downgrade_backoff <duration>
# enables the bandwidth estimator
--webrtc.estimator.enabled <boolean>
# initial bitrate for the bandwidth estimator
--webrtc.estimator.initial_bitrate <int>
# passive estimator mode, when it does not switch pipelines, only estimates
--webrtc.estimator.passive <boolean>
# how often to read and process bandwidth estimation reports
--webrtc.estimator.read_interval <duration>
# how long to wait for stable connection (upward or neutral trend) before upgrading
--webrtc.estimator.stable_duration <duration>
# how long to wait for stalled bandwidth estimation before downgrading
--webrtc.estimator.stalled_duration <duration>
# how long to wait for stalled connection (neutral trend with low bandwidth) before downgrading
--webrtc.estimator.unstable_duration <duration>
# how long to wait before upgrading again after previous upgrade
--webrtc.estimator.upgrade_backoff <duration>
# configures whether or not the ICE agent should be a lite agent
--webrtc.icelite <boolean>
# Backend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
--webrtc.iceservers.backend <urls>
# Frontend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
--webrtc.iceservers.frontend <urls>
# configures whether cadidates should be sent asynchronously using Trickle ICE
--webrtc.icetrickle <boolean>
# URL address used for retrieval of the external IP address
--webrtc.ip_retrieval_url <string>
# sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used
--webrtc.nat1to1 <strings>
# single TCP mux port for all peers
--webrtc.tcpmux <int>
# single UDP mux port for all peers, replaces EPR
--webrtc.udpmux <int>
# configuration file path
--config <string>
# enable debug mode
--debug <boolean>
# logging directory to store logs
--log.dir <string>
# logs in JSON format
--log.json <boolean>
# set log level (trace, debug, info, warn, error, fatal, panic, disabled)
--log.level <string>
# no ANSI colors in non-JSON output
--log.nocolor <boolean>
# time format used in logs (unix, unixms, unixmicro)
--log.time <string>

You can create a /etc/neko/neko.yaml file with the following configuration options.

capture:
  audio:
    # audio codec to be used
    codec: "opus"
    # pulseaudio device to capture
    device: "audio_output.monitor"
    # gstreamer pipeline used for audio streaming
    pipeline: <string>
  broadcast:
    # broadcast audio bitrate in KB/s
    audio_bitrate: 128
    # automatically start broadcasting when neko starts and broadcast_url is set
    autostart: true
    # gstreamer pipeline used for broadcasting
    pipeline: <string>
    # broadcast speed preset for h264 encoding
    preset: "veryfast"
    # initial URL for broadcasting, setting this value will automatically start broadcasting
    url: <string>
    # broadcast video bitrate in KB/s
    video_bitrate: 4096
  microphone:
    # pulseaudio device used for microphone
    device: "audio_input"
    # enable microphone stream
    enabled: true
  screencast:
    # enable screencast
    enabled: false
    # gstreamer pipeline used for screencasting
    pipeline: <string>
    # screencast JPEG quality
    quality: "60"
    # screencast frame rate
    rate: "10/1"
  video:
    # video codec to be used
    codec: "vp8"
    # X display to capture
    display: <string>
    # ordered list of video ids
    ids: [ <string> ]
    # pipelines config in JSON used for video streaming
    pipelines: "[]"
  webcam:
    # v4l2sink device used for webcam
    device: "/dev/video0"
    # enable webcam stream
    enabled: false
    # webcam stream height
    height: 720
    # webcam stream width
    width: 1280
desktop:
  # X display to use for desktop sharing
  display: <string>
  # whether to handle file chooser dialog externally
  file_chooser_dialog: false
  input:
    # whether custom xf86 input driver should be used to handle touchscreen
    enabled: true
    # socket path for custom xf86 input driver connection
    socket: "/tmp/xf86-input-neko.sock"
  # default screen size and framerate
  screen: "1280x720@30"
  # automatically unminimize window when it is minimized
  unminimize: true
  # whether drop upload is enabled
  upload_drop: true
member:
  file:
    # member file provider: whether to hash passwords using sha256 (recommended)
    hash: true
    # member file provider: storage path
    path: <string>
  multiuser:
    # member multiuser provider: admin password
    admin_password: "admin"
    # member multiuser provider: admin profile in JSON format
    admin_profile: "{}"
    # member multiuser provider: user password
    user_password: "neko"
    # member multiuser provider: user profile in JSON format
    user_profile: "{}"
  object:
    # member object provider: users in JSON format
    users: "[]"
  # choose member provider
  provider: "multiuser"
plugins:
  # path to neko plugins to load
  dir: "./bin/plugins"
  # load plugins in runtime
  enabled: false
  # if true, neko will exit if there is an error when loading a plugin
  required: false
server:
  # address/port/socket to serve neko
  bind: "127.0.0.1:8080"
  # path to the SSL cert used to secure the neko server
  cert: <string>
  # list of allowed origins for CORS, if empty CORS is disabled, if '*' is present all origins are allowed
  cors: [ <string> ]
  # path to the SSL key used to secure the neko server
  key: <string>
  # enable prometheus metrics available at /metrics
  metrics: true
  # path prefix for HTTP requests
  path_prefix: "/"
  # enable pprof endpoint available at /debug/pprof
  pprof: false
  # trust reverse proxy headers
  proxy: false
  # path to neko client files to serve
  static: <string>
session:
  # API token for interacting with external services
  api_token: <string>
  # users can gain control only if at least one admin is in the room
  control_protection: false
  cookie:
    # domain of the cookie
    domain: <string>
    # whether cookies authentication should be enabled
    enabled: true
    # expiration of the cookie
    expiration: "24h0m0s"
    # use http only cookies
    http_only: true
    # name of the cookie that holds token
    name: "NEKO_SESSION"
    # path of the cookie
    path: <string>
    # use secure cookies
    secure: true
  # if sessions should be stored in a file, otherwise they will be stored only in memory
  file: <string>
  # interval in seconds for sending heartbeat messages
  heartbeat_interval: 120
  # allow implicit control switching
  implicit_hosting: true
  # show inactive cursors on the screen
  inactive_cursors: false
  # whether controls should be locked for users initially
  locked_controls: false
  # whether logins should be locked for users initially
  locked_logins: false
  # allow reconnecting to websocket even if previous connection was not closed
  merciful_reconnect: true
  # whether private mode should be enabled initially
  private_mode: false
webrtc:
  # limits the pool of ephemeral ports that ICE UDP connections can allocate from
  epr: <string>
  estimator:
    # enables debug logging for the bandwidth estimator
    debug: false
    # how bigger the difference between estimated and stream bitrate must be to trigger upgrade/downgrade
    diff_threshold: 0.15
    # how long to wait before downgrading again after previous downgrade
    downgrade_backoff: "10s"
    # enables the bandwidth estimator
    enabled: false
    # initial bitrate for the bandwidth estimator
    initial_bitrate: 1000000
    # passive estimator mode, when it does not switch pipelines, only estimates
    passive: false
    # how often to read and process bandwidth estimation reports
    read_interval: "2s"
    # how long to wait for stable connection (upward or neutral trend) before upgrading
    stable_duration: "12s"
    # how long to wait for stalled bandwidth estimation before downgrading
    stalled_duration: "24s"
    # how long to wait for stalled connection (neutral trend with low bandwidth) before downgrading
    unstable_duration: "6s"
    # how long to wait before upgrading again after previous upgrade
    upgrade_backoff: "5s"
  # configures whether or not the ICE agent should be a lite agent
  icelite: false
  iceservers:
    # Backend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
    backend: <urls>
    # Frontend only STUN and TURN servers in JSON format with urls, `username` and `credential` keys
    frontend: <urls>
  # configures whether cadidates should be sent asynchronously using Trickle ICE
  icetrickle: true
  # URL address used for retrieval of the external IP address
  ip_retrieval_url: "https://checkip.amazonaws.com"
  # sets a list of external IP addresses of 1:1 (D)NAT and a candidate type for which the external IP address is used
  nat1to1: [ <string> ]
  # single TCP mux port for all peers
  tcpmux: 0
  # single UDP mux port for all peers, replaces EPR
  udpmux: 0
# configuration file path
config: <string>
# enable debug mode
debug: false
log:
  # logging directory to store logs
  dir: <string>
  # logs in JSON format
  json: false
  # set log level (trace, debug, info, warn, error, fatal, panic, disabled)
  level: "info"
  # no ANSI colors in non-JSON output
  nocolor: false
  # time format used in logs (unix, unixms, unixmicro)
  time: "unix"

Configuration

Configuration File

Room Configuration

Server Configuration

Logging Configuration

Full Configuration Reference

Next Steps

📄️ Authentication

📄️ Audio & Video Capture

📄️ Desktop Environment

📄️ WebRTC Configuration

📄️ Plugins Configuration

Configuration File​

Room Configuration​

Server Configuration​

Logging Configuration​

Full Configuration Reference​

Next Steps​

📄️ Authentication

📄️ Audio & Video Capture

📄️ Desktop Environment

📄️ WebRTC Configuration

📄️ Plugins Configuration

Configuration File

Room Configuration

Server Configuration

Logging Configuration

Full Configuration Reference

Next Steps