BIG docs refactoring
This commit is contained in:
+35
-8
@@ -1,3 +1,9 @@
|
||||
# App
|
||||
|
||||
The application module is responsible for reading configuration files and running other modules.
|
||||
|
||||
The configuration can be edited through the application's WebUI with code highlighting, syntax and specification checking.
|
||||
|
||||
- By default, go2rtc will search for the `go2rtc.yaml` config file in the current working directory
|
||||
- go2rtc supports multiple config files:
|
||||
- `go2rtc -c config1.yaml -c config2.yaml -c config3.yaml`
|
||||
@@ -38,6 +44,12 @@ Editors like [GoLand](https://www.jetbrains.com/go/) and [VS Code](https://code.
|
||||
# yaml-language-server: $schema=https://raw.githubusercontent.com/AlexxIT/go2rtc/master/www/schema.json
|
||||
```
|
||||
|
||||
or from a running go2rtc:
|
||||
|
||||
```yaml
|
||||
# yaml-language-server: $schema=http://localhost:1984/schema.json
|
||||
```
|
||||
|
||||
## Defaults
|
||||
|
||||
- Default values may change in updates
|
||||
@@ -45,26 +57,41 @@ Editors like [GoLand](https://www.jetbrains.com/go/) and [VS Code](https://code.
|
||||
|
||||
```yaml
|
||||
api:
|
||||
listen: ":1984"
|
||||
listen: ":1984" # default public port for WebUI and HTTP API
|
||||
|
||||
ffmpeg:
|
||||
bin: "ffmpeg"
|
||||
bin: "ffmpeg" # default binary path for FFmpeg
|
||||
|
||||
log:
|
||||
format: "color"
|
||||
level: "info"
|
||||
level: "info" # default log level
|
||||
output: "stdout"
|
||||
time: "UNIXMS"
|
||||
|
||||
rtsp:
|
||||
listen: ":8554"
|
||||
listen: ":8554" # default public port for RTSP server
|
||||
default_query: "video&audio"
|
||||
|
||||
srtp:
|
||||
listen: ":8443"
|
||||
listen: ":8443" # default public port for SRTP server (used for HomeKit)
|
||||
|
||||
webrtc:
|
||||
listen: ":8555/tcp"
|
||||
listen: ":8555" # default public port for WebRTC server (TCP and UDP)
|
||||
ice_servers:
|
||||
- urls: [ "stun:stun.l.google.com:19302" ]
|
||||
- urls: [ "stun:stun.cloudflare.com:3478", "stun:stun.l.google.com:19302" ]
|
||||
```
|
||||
|
||||
## Log
|
||||
|
||||
You can set different log levels for different modules.
|
||||
|
||||
```yaml
|
||||
log:
|
||||
format: "" # empty (default, autodetect color support), color, json, text
|
||||
level: "info" # disabled, trace, debug, info (default), warn, error
|
||||
output: "stdout" # empty (only to memory), stderr, stdout (default)
|
||||
time: "UNIXMS" # empty (disable timestamp), UNIXMS (default), UNIXMICRO, UNIXNANO
|
||||
|
||||
api: trace # module name: log level
|
||||
```
|
||||
|
||||
Modules: `api`, `streams`, `rtsp`, `webrtc`, `mp4`, `hls`, `mjpeg`, `hass`, `homekit`, `onvif`, `rtmp`, `webtorrent`, `wyoming`, `echo`, `exec`, `expr`, `ffmpeg`, `wyze`, `xiaomi`.
|
||||
|
||||
Reference in New Issue
Block a user