Skip to content

Commit 5b6c88d

Browse files
docs: improve grammar and style, including capitalization and phrasing (#285)
Signed-off-by: Patrick Gehrsitz <[email protected]> Co-authored-by: Patrick Gehrsitz <[email protected]>
1 parent 8cae23c commit 5b6c88d

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

resources/crowsnest.conf

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
#### crowsnest.conf
2-
#### This is a typical default config.
3-
#### Also used as default in mainsail / MainsailOS
4-
#### See:
2+
#### This is the default config after installation.
3+
#### It is also used as the default config in MainsailOS.
4+
#### For details on how to configure this to your needs, see:
55
#### https://github.com/mainsail-crew/crowsnest/blob/master/README.md
6-
#### for details to configure to your needs.
76

87

98
#####################################################################
@@ -18,8 +17,9 @@
1817
#### Port 8083 equals /webcam4/?action=[stream/snapshot] #####
1918
#### #####
2019
#### Note: These ports are default for most Mainsail #####
21-
#### installations. To use any other port would involve #####
22-
#### changing the proxy configuration or using directly #####
20+
#### installations. Using any other port would involve #####
21+
#### changing the proxy configuration or using URLs #####
22+
#### with the specific port like #####
2323
#### http://<ip>:<port>/?action=[stream/snapshot] #####
2424
#### #####
2525
#####################################################################
@@ -32,16 +32,16 @@
3232
log_path: %LOGPATH%
3333
log_level: verbose # Valid Options are quiet/verbose/debug
3434
delete_log: false # Deletes log on every restart, if set to true
35-
no_proxy: false
35+
no_proxy: false # If set to true, no reverse proxy is required. Only change this, if you know what you are doing.
3636

3737
[cam 1]
38-
mode: ustreamer # ustreamer - Provides mjpg and snapshots. (All devices)
39-
# camera-streamer - Provides webrtc, mjpg and snapshots. (rpi + Raspi OS based only)
40-
enable_rtsp: false # If camera-streamer is used, this enables also usage of an rtsp server
38+
mode: ustreamer # ustreamer - Provides MJPG and snapshots. (All devices)
39+
# camera-streamer - Provides WebRTC, MJPG and snapshots. (only RPiOS + RPi 0/1/2/3/4)
40+
enable_rtsp: false # If camera-streamer is used, this also enables usage of an RTSP server
4141
rtsp_port: 8554 # Set different ports for each device!
42-
port: 8080 # HTTP/MJPG Stream/Snapshot Port
43-
device: /dev/video0 # See Log for available ...
44-
resolution: 640x480 # widthxheight format
45-
max_fps: 15 # If Hardware Supports this it will be forced, otherwise ignored/coerced.
46-
#custom_flags: # You can run the Stream Services with custom flags.
47-
#v4l2ctl: # Add v4l2-ctl parameters to setup your camera, see Log what your cam is capable of.
42+
port: 8080 # HTTP/MJPG stream/snapshot port
43+
device: /dev/video0 # See log for available devices
44+
resolution: 640x480 # <width>x<height> format
45+
max_fps: 15 # If hardware supports it, it will be forced, otherwise ignored/coerced.
46+
#custom_flags: # You can run the stream services with custom flags.
47+
#v4l2ctl: # Add v4l2-ctl parameters to setup your camera, see log for your camera capabilities.

0 commit comments

Comments
 (0)