Documentation ¶
Index ¶
Constants ¶
const ( // StaticVersionNumber is the version of Owncast that is used when it's not overwritten via build-time settings. StaticVersionNumber = "0.1.3" // Shown when you build from develop // 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 defines the URL route prefix for emoji requests. EmojiDir = "/img/emoji/" // MaxUserColor is the largest color value available to assign to users. // They start at 0 and can be treated as IDs more than colors themselves. MaxUserColor = 7 // MaxChatDisplayNameLength is the maximum length of a chat display name. MaxChatDisplayNameLength = 30 )
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") // CustomEmojiPath is the emoji directory. CustomEmojiPath = filepath.Join(DataDirectory, "emoji") // PublicFilesPath is the optional directory for hosting public files. PublicFilesPath = filepath.Join(DataDirectory, "public") )
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 EnableAutoUpdate = false
EnableAutoUpdate will explicitly enable in-place auto-updates via the admin.
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 TempDir = "./data/tmp"
TempDir is where we store temporary files.
var TemporaryStreamKey = ""
A temporary stream key that can be set via the command line.
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 ¶ added in v0.0.8
func GetCommit() string
GetCommit will return an identifier used for identifying the point in time this build took place.
func GetReleaseString ¶ added in v0.0.6
func GetReleaseString() string
GetReleaseString gets the version string.
func VerifyFFMpegPath ¶ added in v0.0.6
VerifyFFMpegPath verifies that the path exists, is a file, and is executable.
Types ¶
type Defaults ¶ added in v0.0.6
type Defaults struct { PageBodyContent string FederationGoLiveMessage string Summary string ServerWelcomeMessage string Logo string YPServer string Title string DatabaseFilePath string FederationUsername string WebServerIP string Name string AdminPassword string StreamKeys []models.StreamKey StreamVariants []models.StreamOutputVariant Tags []string RTMPServerPort int SegmentsInPlaylist int SegmentLengthSeconds int WebServerPort int ChatEstablishedUserModeTimeDuration time.Duration YPEnabled bool }
Defaults will hold default configuration values.
func GetDefaults ¶ added in v0.0.6
func GetDefaults() Defaults
GetDefaults will return default configuration values.