Skip to content

Latest commit

 

History

History
119 lines (90 loc) · 3.81 KB

README.md

File metadata and controls

119 lines (90 loc) · 3.81 KB

Configuration

This page describes the enviroment settings the application accepts. You can find the API configuration here.

You can configure the following settings in the application with environment variables:

Transcoding related configuration:

The project uses Lumberjack for the log rotation of the ffmpeg transcoding processes.

RTSP_STREAM_CLEANUP_ENABLED

Default: true
Type: boolean
Description: Turns on / off the cleanup mechanism which stops inactive streams

RTSP_STREAM_CLEANUP_TIME

Default: 2m0s
Type: string
Description: Time period for the cleanup process that removes inactive streams. Info on format here

RTSP_STREAM_STORE_DIR

Default: ./videos
Type: string
Description: Sub directory to store the video chunks

RTSP_STREAM_AUDIO_ENABLED

Default: true
Type: boolean
Description: Indicates if transcoding will also include audio or not

RTSP_STREAM_KEEP_FILES

Default: false
Type: bool
Description: Option to keep the chunks for the stream being transcoded

RTSP_STREAM_PROCESS_LOGGING_ENABLED

Default: false
Type: bool
Description: Indicates if logging of transcoding ffmpeg processes is enabled or not

RTSP_STREAM_PROCESS_LOGGING_DIR

Default: /var/log/rtsp-stream
Type: string
Description: Describes the directory where ffmpeg process logs are stored

RTSP_STREAM_PROCESS_LOGGING_MAX_SIZE

Default: 500
Type: integer
Description: Maximum size of each log file in megabytes for retention

RTSP_STREAM_PROCESS_LOGGING_MAX_AGE

Default: 7
Type: integer
Description: Maximum number of days that we store a given log file

RTSP_STREAM_PROCESS_LOGGING_MAX_BACKUPS

Default: 3
Type: integer
Description: Maximum number of old log files to retain for each ffmpeg process

RTSP_STREAM_PROCESS_LOGGING_COMPRESS

Default: true
Type: bool
Description: Option to compress the rotated log file or not


HTTP related configuration:

RTSP_STREAM_PORT

Default: 8080
Type: integer
Description: Port where the application listens

RTSP_STREAM_DEBUG

Default: false
Type: bool
Description: Turns on / off debug features

RTSP_STREAM_BLACKLIST_ENABLED

Default: true
Type: bool
Description: Option to turn on / off blacklist that can filter requests with unloadable streams

RTSP_STREAM_BLACKLIST_LIMIT

Default: 25
Type: int
Description: Determines how many times a given URI can be tried to start. After this amount the given URI is getting blacklisted

RTSP_STREAM_BLACKLIST_TIME

Default: 1h
Type: string
Description: Time period which after a blacklisted stream can be removed from the list Info on format here


CORS related configuration

By default all origin is allowed to make requests to the server, but you might want to configure it for security reasons.

RTSP_STREAM_CORS_ENABLED

Default: false
Type: bool
Description: Indicates if cors should be handled as configured or as default (everything allowed)

RTSP_STREAM_CORS_ALLOWED_ORIGIN

Default:
Type: []string
Description: A list of origins a cross-domain request can be executed from

RTSP_STREAM_CORS_ALLOW_CREDENTIALS

Default: false
Type: bool
Description: Indicates whether the request can include user credentials like cookies, HTTP authentication or client side SSL certificates

RTSP_STREAM_CORS_MAX_AGE

Default: 0
Type: integer
Description: Indicates how long (in seconds) the results of a preflight request can be cached