m1k1o / neko

A self hosted virtual browser that runs in docker and uses WebRTC.
https://neko.m1k1o.net/
Apache License 2.0
7.17k stars 526 forks source link

Document config file #142

Closed e00E closed 2 years ago

e00E commented 2 years ago

The documentation mentions

You can mount YAML config file to docker container on this path /etc/neko/neko.yaml and store your configuration there.

However I cannot find any documentation on the format of the config file. There should be an example config file that contains all the options.

m1k1o commented 2 years ago

All the keys from arguments, that can be viewed in program's help output.

Example, setting nat1to1 variable:

So the config would look like this (taken just some of the arguments):

# audio bitrate in kbit/s
audio_bitrate: 128

# video bitrate in kbit/s
video_bitrate: 3072

# maximum fps delivered via WebRTC, 0 is for no maximum
max_fps: 25

# password for connecting to stream
password: "neko"

# admin password for connecting to stream
password_admin: "admin"

# default screen resolution and framerate
screen: "1280x720@30"

# limits the pool of ephemeral ports that ICE UDP connections can allocate from
epr: "59000-59100"
e00E commented 2 years ago

Thank you for the explanation. It would be nice to put this right in that section of the docs.