Documentation
¶
Index ¶
- Constants
- func GetAutostartVideo() bool
- func GetCSS() string
- func GetCSSEnabled() bool
- func GetCSSPath() string
- func GetCachePath() string
- func GetConfigFilePath() string
- func GetConfigPath() string
- func GetCreateGalleriesFromFolders() bool
- func GetCredentials() (string, string)
- func GetDatabasePath() string
- func GetDefaultPluginsPath() string
- func GetDefaultScrapersPath() string
- func GetExcludes() []string
- func GetExternalHost() string
- func GetGalleryExtensions() []string
- func GetGeneratedPath() string
- func GetHost() string
- func GetImageExcludes() []string
- func GetImageExtensions() []string
- func GetJWTSignKey() []byte
- func GetLanguage() string
- func GetLogAccess() bool
- func GetLogFile() string
- func GetLogLevel() string
- func GetLogOut() bool
- func GetMaxSessionAge() int
- func GetMaxStreamingTranscodeSize() models.StreamingResolutionEnum
- func GetMaxTranscodeSize() models.StreamingResolutionEnum
- func GetMaxUploadSize() int64
- func GetMaximumLoopDuration() int
- func GetMenuItems() []string
- func GetMetadataPath() string
- func GetParallelTasks() int
- func GetParallelTasksWithAutoDetection() int
- func GetPasswordHash() string
- func GetPluginsPath() string
- func GetPort() int
- func GetPreviewExcludeEnd() string
- func GetPreviewExcludeStart() string
- func GetPreviewPreset() models.PreviewPreset
- func GetPreviewSegmentDuration() float64
- func GetPreviewSegments() int
- func GetScraperCDPPath() string
- func GetScraperCertCheck() bool
- func GetScraperUserAgent() string
- func GetScrapersPath() string
- func GetSessionStoreKey() []byte
- func GetShowStudioAsText() bool
- func GetSoundOnPreview() bool
- func GetStashBoxes() []*models.StashBox
- func GetStashPaths() []*models.StashConfig
- func GetUsername() string
- func GetVideoExtensions() []string
- func GetVideoFileNamingAlgorithm() models.HashAlgorithm
- func GetWallPlayback() string
- func GetWallShowTitle() bool
- func HasCredentials() bool
- func IsCalculateMD5() bool
- func IsValid() bool
- func Set(key string, value interface{})
- func SetCSS(css string)
- func SetInitialConfig() error
- func SetPassword(value string)
- func ValidateCredentials(username string, password string) bool
- func ValidateStashBoxes(boxes []*models.StashBoxInput) error
- func Write() error
- type URLMap
Constants ¶
const AutostartVideo = "autostart_video"
const CSSEnabled = "cssEnabled"
const Cache = "cache"
const CalculateMD5 = "calculate_md5"
CalculateMD5 is the config key used to determine if MD5 should be calculated for video files.
const CreateGalleriesFromFolders = "create_galleries_from_folders"
const CustomServedFolders = "custom_served_folders"
served directories this should be manually configured only
const Database = "database"
const DefaultMaxSessionAge = 60 * 60 * 1 // 1 hours
const Downloads = "downloads"
const Exclude = "exclude"
const ExternalHost = "external_host"
const GalleryExtensions = "gallery_extensions"
const Generated = "generated"
const Host = "host"
const ImageExclude = "image_exclude"
const ImageExtensions = "image_extensions"
const JWTSignKey = "jwt_secret_key"
key used to sign JWT tokens
const Language = "language"
i18n
const LogAccess = "logAccess"
const LogFile = "logFile"
Logging options
const LogLevel = "logLevel"
const LogOut = "logOut"
const MaxSessionAge = "max_session_age"
const MaxStreamingTranscodeSize = "max_streaming_transcode_size"
const MaxTranscodeSize = "max_transcode_size"
const MaxUploadSize = "max_upload_size"
File upload options
const MaximumLoopDuration = "maximum_loop_duration"
const MenuItems = "menu_items"
Interface options
const Metadata = "metadata"
const ParallelTasks = "parallel_tasks"
const Password = "password"
const PluginsPath = "plugins_path"
plugin options
const Port = "port"
const PreviewExcludeEnd = "preview_exclude_end"
const PreviewExcludeStart = "preview_exclude_start"
const PreviewPreset = "preview_preset"
const PreviewSegmentDuration = "preview_segment_duration"
const PreviewSegments = "preview_segments"
const ScraperCDPPath = "scraper_cdp_path"
const ScraperCertCheck = "scraper_cert_check"
const ScraperUserAgent = "scraper_user_agent"
const ScrapersPath = "scrapers_path"
scraping options
const SessionStoreKey = "session_store_key"
key used for session store
const ShowStudioAsText = "show_studio_as_text"
const SoundOnPreview = "sound_on_preview"
const Stash = "stash"
const StashBoxes = "stash_boxes"
stash-box options
const Username = "username"
const VideoExtensions = "video_extensions"
const VideoFileNamingAlgorithm = "video_file_naming_algorithm"
VideoFileNamingAlgorithm is the config key used to determine what hash should be used when generating and using generated files for scenes.
const WallPlayback = "wall_playback"
const WallShowTitle = "wall_show_title"
Variables ¶
This section is empty.
Functions ¶
func GetAutostartVideo ¶
func GetAutostartVideo() bool
func GetCSSEnabled ¶
func GetCSSEnabled() bool
func GetCSSPath ¶
func GetCSSPath() string
func GetCachePath ¶
func GetCachePath() string
func GetConfigFilePath ¶ added in v0.6.0
func GetConfigFilePath() string
func GetConfigPath ¶ added in v0.3.0
func GetConfigPath() string
func GetCreateGalleriesFromFolders ¶ added in v0.4.0
func GetCreateGalleriesFromFolders() bool
func GetCredentials ¶
func GetDatabasePath ¶
func GetDatabasePath() string
func GetDefaultPluginsPath ¶ added in v0.3.0
func GetDefaultPluginsPath() string
func GetDefaultScrapersPath ¶
func GetDefaultScrapersPath() string
func GetExcludes ¶
func GetExcludes() []string
func GetExternalHost ¶
func GetExternalHost() string
func GetGalleryExtensions ¶ added in v0.4.0
func GetGalleryExtensions() []string
func GetGeneratedPath ¶
func GetGeneratedPath() string
func GetImageExcludes ¶ added in v0.4.0
func GetImageExcludes() []string
func GetImageExtensions ¶ added in v0.4.0
func GetImageExtensions() []string
func GetJWTSignKey ¶ added in v0.2.0
func GetJWTSignKey() []byte
func GetLanguage ¶ added in v0.2.0
func GetLanguage() string
func GetLogAccess ¶
func GetLogAccess() bool
GetLogAccess returns true if http requests should be logged to the terminal. HTTP requests are not logged to the log file. Defaults to true.
func GetLogFile ¶
func GetLogFile() string
GetLogFile returns the filename of the file to output logs to. An empty string means that file logging will be disabled.
func GetLogLevel ¶
func GetLogLevel() string
GetLogLevel returns the lowest log level to write to the log. Should be one of "Debug", "Info", "Warning", "Error"
func GetLogOut ¶
func GetLogOut() bool
GetLogOut returns true if logging should be output to the terminal in addition to writing to a log file. Logging will be output to the terminal if file logging is disabled. Defaults to true.
func GetMaxSessionAge ¶ added in v0.2.0
func GetMaxSessionAge() int
GetMaxSessionAge gets the maximum age for session cookies, in seconds. Session cookie expiry times are refreshed every request.
func GetMaxStreamingTranscodeSize ¶
func GetMaxStreamingTranscodeSize() models.StreamingResolutionEnum
func GetMaxTranscodeSize ¶
func GetMaxTranscodeSize() models.StreamingResolutionEnum
func GetMaxUploadSize ¶ added in v0.5.0
func GetMaxUploadSize() int64
Max allowed graphql upload size in megabytes
func GetMaximumLoopDuration ¶
func GetMaximumLoopDuration() int
func GetMetadataPath ¶
func GetMetadataPath() string
func GetParallelTasks ¶ added in v0.5.0
func GetParallelTasks() int
GetParallelTasks returns the number of parallel tasks that should be started by scan or generate task.
func GetParallelTasksWithAutoDetection ¶ added in v0.5.0
func GetParallelTasksWithAutoDetection() int
func GetPasswordHash ¶
func GetPasswordHash() string
func GetPluginsPath ¶ added in v0.3.0
func GetPluginsPath() string
func GetPreviewExcludeEnd ¶ added in v0.3.0
func GetPreviewExcludeEnd() string
GetPreviewExcludeEnd returns the configuration setting string for excluding the end of scene videos for preview generation. A float value is interpreted as the amount of seconds to exclude from the end of the video when generating previews. If the value is suffixed with a '%' character, then it is interpreted as a proportion of the total video duration.
func GetPreviewExcludeStart ¶ added in v0.3.0
func GetPreviewExcludeStart() string
GetPreviewExcludeStart returns the configuration setting string for excluding the start of scene videos for preview generation. This can be in two possible formats. A float value is interpreted as the amount of seconds to exclude from the start of the video before it is included in the preview. If the value is suffixed with a '%' character (for example '2%'), then it is interpreted as a proportion of the total video duration.
func GetPreviewPreset ¶ added in v0.3.0
func GetPreviewPreset() models.PreviewPreset
GetPreviewPreset returns the preset when generating previews. Defaults to Slow.
func GetPreviewSegmentDuration ¶ added in v0.3.0
func GetPreviewSegmentDuration() float64
GetPreviewSegmentDuration returns the duration of a single segment in a scene preview file, in seconds.
func GetPreviewSegments ¶ added in v0.3.0
func GetPreviewSegments() int
GetPreviewSegments returns the amount of segments in a scene preview file.
func GetScraperCDPPath ¶ added in v0.3.0
func GetScraperCDPPath() string
GetScraperCDPPath gets the path to the Chrome executable or remote address to an instance of Chrome.
func GetScraperCertCheck ¶ added in v0.6.0
func GetScraperCertCheck() bool
GetScraperCertCheck returns true if the scraper should check for insecure certificates when fetching an image or a page.
func GetScraperUserAgent ¶ added in v0.2.0
func GetScraperUserAgent() string
func GetScrapersPath ¶
func GetScrapersPath() string
func GetSessionStoreKey ¶ added in v0.2.0
func GetSessionStoreKey() []byte
func GetShowStudioAsText ¶
func GetShowStudioAsText() bool
func GetSoundOnPreview ¶
func GetSoundOnPreview() bool
func GetStashBoxes ¶ added in v0.4.0
func GetStashPaths ¶
func GetStashPaths() []*models.StashConfig
func GetUsername ¶
func GetUsername() string
func GetVideoExtensions ¶ added in v0.4.0
func GetVideoExtensions() []string
func GetVideoFileNamingAlgorithm ¶ added in v0.3.0
func GetVideoFileNamingAlgorithm() models.HashAlgorithm
GetVideoFileNamingAlgorithm returns what hash algorithm should be used for naming generated scene video files.
func GetWallPlayback ¶ added in v0.2.0
func GetWallPlayback() string
func GetWallShowTitle ¶
func GetWallShowTitle() bool
func HasCredentials ¶
func HasCredentials() bool
func IsCalculateMD5 ¶ added in v0.3.0
func IsCalculateMD5() bool
IsCalculateMD5 returns true if MD5 checksums should be generated for scene video files.
func SetInitialConfig ¶ added in v0.2.0
func SetInitialConfig() error
SetInitialConfig fills in missing required config fields
func SetPassword ¶
func SetPassword(value string)
func ValidateCredentials ¶
func ValidateStashBoxes ¶ added in v0.4.0
func ValidateStashBoxes(boxes []*models.StashBoxInput) error
Types ¶
type URLMap ¶ added in v0.3.0
func GetCustomServedFolders ¶ added in v0.3.0
func GetCustomServedFolders() URLMap
GetCustomServedFolders gets the map of custom paths to their applicable filesystem locations
Source Files