Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve grammar and style, including capitalization and phrasing #285

Merged
merged 5 commits into from
Feb 19, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions resources/crowsnest.conf
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
#### crowsnest.conf
#### This is a typical default config.
#### Also used as default in mainsail / MainsailOS
#### See:
#### This is the default config after installation.
#### It is also used as the default config in MainsailOS.
#### For details on how to configure this to your needs, see:
#### https://github.com/mainsail-crew/crowsnest/blob/master/README.md
#### for details to configure to your needs.


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

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