Documentation
¶
Index ¶
Constants ¶
const ( // StaticVersionNumber is the version of Owncast that is used when it's not overwritten via build-time settings. StaticVersionNumber = "0.0.10" // Shown when you build from develop // WebRoot is the web server root directory. WebRoot = "webroot" // FfmpegSuggestedVersion is the version of ffmpeg we suggest. FfmpegSuggestedVersion = "v4.1.5" // Requires the v // DataDirectory is the directory we save data to. DataDirectory = "data" // EmojiDir is relative to the webroot. EmojiDir = "/img/emoji" )
const MaxSocketPayloadSize = 2048
MaxSocketPayloadSize is the maximum payload we will allow to to be received via the chat socket.
Variables ¶
var ( // BackupDirectory is the directory we write backup files to. BackupDirectory = filepath.Join(DataDirectory, "backup") // HLSStoragePath is the directory HLS video is written to. HLSStoragePath = filepath.Join(DataDirectory, "hls") )
var BuildPlatform = "dev"
BuildPlatform is the optional platform this release was built for.
var DatabaseFilePath = "data/owncast.db"
DatabaseFilePath is the path to the file ot be used as the global database for this run of the application.
var DefaultForbiddenUsernames = []string{
"owncast", "operator", "admin", "system",
}
DefaultForbiddenUsernames are a list of usernames forbidden from being used in chat.
var EnableDebugFeatures = false
EnableDebugFeatures will print additional data to help in debugging.
var GitCommit = ""
GitCommit is an optional commit this build was made from.
var InternalHLSListenerPort = "8927"
InternalHLSListenerPort is the port for HLS writes that is used for this execution of the service.
var LogDirectory = "./data/logs"
LogDirectory is the path to various log files.
var VersionNumber = StaticVersionNumber
VersionNumber is the current version string.
var WebServerIP = "0.0.0.0"
WebServerIP is the IP address to bind the web server to. All interfaces by default.
var WebServerPort = 8080
WebServerPort is the port for Owncast's webserver that is used for this execution of the service.
Functions ¶
func GetCommit ¶
func GetCommit() string
GetCommit will return an identifier used for identifying the point in time this build took place.
func VerifyFFMpegPath ¶
VerifyFFMpegPath verifies that the path exists, is a file, and is executable.
Types ¶
type Defaults ¶
type Defaults struct {
Name string
Title string
Summary string
ServerWelcomeMessage string
Logo string
Tags []string
PageBodyContent string
DatabaseFilePath string
WebServerPort int
WebServerIP string
RTMPServerPort int
StreamKey string
YPEnabled bool
YPServer string
SegmentLengthSeconds int
SegmentsInPlaylist int
StreamVariants []models.StreamOutputVariant
}
Defaults will hold default configuration values.
func GetDefaults ¶
func GetDefaults() Defaults
GetDefaults will return default configuration values.
Source Files