Documentation
¶
Index ¶
- Constants
- Variables
- func GetApiUrl(ctx context.Context) string
- func ResetStoragesLoadSignal()
- func SendStoragesLoadedSignal()
- func StoragesLoadSignal() <-chan struct{}
- type Config
- type ContextKey
- type Cors
- type Database
- type FTP
- type Filter
- type LogConfig
- type LogFilterConfig
- type MCP
- type Meilisearch
- type S3
- type SFTP
- type Scheme
- type TaskConfig
- type TasksConfig
Constants ¶
View Source
const ( TypeString = "string" TypeSelect = "select" TypeBool = "bool" TypeText = "text" TypeNumber = "number" )
View Source
const ( // site VERSION = "version" SiteTitle = "site_title" Announcement = "announcement" AllowIndexed = "allow_indexed" AllowMounted = "allow_mounted" RobotsTxt = "robots_txt" Logo = "logo" // multi-lines text, L1: light, EOL: dark Favicon = "favicon" MainColor = "main_color" HideStorageDetails = "hide_storage_details" HideStorageDetailsInManagePage = "hide_storage_details_in_manage_page" // preview TextTypes = "text_types" AudioTypes = "audio_types" VideoTypes = "video_types" ImageTypes = "image_types" ProxyTypes = "proxy_types" ProxyIgnoreHeaders = "proxy_ignore_headers" AudioAutoplay = "audio_autoplay" VideoAutoplay = "video_autoplay" PreviewDownloadByDefault = "preview_download_by_default" PreviewArchivesByDefault = "preview_archives_by_default" ReadMeAutoRender = "readme_autorender" FilterReadMeScripts = "filter_readme_scripts" NonEFSZipEncoding = "non_efs_zip_encoding" // global HideFiles = "hide_files" CustomizeHead = "customize_head" CustomizeBody = "customize_body" LinkExpiration = "link_expiration" SignAll = "sign_all" PrivacyRegs = "privacy_regs" OcrApi = "ocr_api" FilenameCharMapping = "filename_char_mapping" ForwardDirectLinkParams = "forward_direct_link_params" IgnoreDirectLinkParams = "ignore_direct_link_params" WebauthnLoginEnabled = "webauthn_login_enabled" HandleHookAfterWriting = "handle_hook_after_writing" HandleHookRateLimit = "handle_hook_rate_limit" IgnoreSystemFiles = "ignore_system_files" // transfer seeds SeedSiteURL = "seed_site_url" SeedDefaultMatrix = "seed_default_matrix" SeedFormatPolicies = "seed_format_policies" SeedDefaultFormat = "seed_default_format" SeedSingleDirectPreview = "seed_single_direct_preview" SeedCASDirectAccess = "seed_cas_direct_access" SeedAutoGeneratePolicy = "seed_auto_generate_policy" SeedDefaultTrackers = "seed_default_trackers" // index SearchIndex = "search_index" AutoUpdateIndex = "auto_update_index" IgnorePaths = "ignore_paths" MaxIndexDepth = "max_index_depth" // aria2 Aria2Uri = "aria2_uri" Aria2Secret = "aria2_secret" // transmission TransmissionUri = "transmission_uri" TransmissionSeedtime = "transmission_seedtime" // 115 Pan115TempDir = "115_temp_dir" // 123 Pan123TempDir = "123_temp_dir" // 115_open Pan115OpenTempDir = "115_open_temp_dir" // pikpak PikPakTempDir = "pikpak_temp_dir" // thunder ThunderTempDir = "thunder_temp_dir" // thunderx ThunderXTempDir = "thunderx_temp_dir" // thunder_browser ThunderBrowserTempDir = "thunder_browser_temp_dir" // guangyapan GuangYaPanTempDir = "guangyapan_temp_dir" // single Token = "token" IndexProgress = "index_progress" // SSO SSOClientId = "sso_client_id" SSOClientSecret = "sso_client_secret" SSOLoginEnabled = "sso_login_enabled" SSOLoginPlatform = "sso_login_platform" SSOOIDCUsernameKey = "sso_oidc_username_key" SSOOrganizationName = "sso_organization_name" SSOApplicationName = "sso_application_name" SSOEndpointName = "sso_endpoint_name" SSOJwtPublicKey = "sso_jwt_public_key" SSOExtraScopes = "sso_extra_scopes" SSOAutoRegister = "sso_auto_register" SSODefaultDir = "sso_default_dir" SSODefaultPermission = "sso_default_permission" SSOCompatibilityMode = "sso_compatibility_mode" SSOPostMessageOrigin = "sso_postmessage_origin" // ldap LdapLoginEnabled = "ldap_login_enabled" LdapServer = "ldap_server" LdapSkipTlsVerify = "ldap_skip_tls_verify" LdapManagerDN = "ldap_manager_dn" LdapManagerPassword = "ldap_manager_password" LdapUserSearchBase = "ldap_user_search_base" LdapUserSearchFilter = "ldap_user_search_filter" LdapDefaultPermission = "ldap_default_permission" LdapDefaultDir = "ldap_default_dir" LdapLoginTips = "ldap_login_tips" // s3 S3Buckets = "s3_buckets" S3AccessKeyId = "s3_access_key_id" S3SecretAccessKey = "s3_secret_access_key" // qbittorrent QbittorrentUrl = "qbittorrent_url" QbittorrentSeedtime = "qbittorrent_seedtime" // 123 open offline download Pan123OpenOfflineDownloadCallbackUrl = "123_open_callback_url" Pan123OpenTempDir = "123_open_temp_dir" // ftp FTPPublicHost = "ftp_public_host" FTPPasvPortMap = "ftp_pasv_port_map" FTPMandatoryTLS = "ftp_mandatory_tls" FTPImplicitTLS = "ftp_implicit_tls" FTPTLSPrivateKeyPath = "ftp_tls_private_key_path" FTPTLSPublicCertPath = "ftp_tls_public_cert_path" SFTPDisablePasswordLogin = "sftp_disable_password_login" // traffic TaskOfflineDownloadThreadsNum = "offline_download_task_threads_num" TaskOfflineDownloadTransferThreadsNum = "offline_download_transfer_task_threads_num" TaskUploadThreadsNum = "upload_task_threads_num" TaskCopyThreadsNum = "copy_task_threads_num" TaskMoveThreadsNum = "move_task_threads_num" TaskDecompressDownloadThreadsNum = "decompress_download_task_threads_num" TaskDecompressUploadThreadsNum = "decompress_upload_task_threads_num" StreamMaxClientDownloadSpeed = "max_client_download_speed" StreamMaxClientUploadSpeed = "max_client_upload_speed" StreamMaxServerDownloadSpeed = "max_server_download_speed" StreamMaxServerUploadSpeed = "max_server_upload_speed" // media MediaTMDBKey = "media_tmdb_key" MediaTMDBAPIURL = "media_tmdb_api_url" MediaDiscogsToken = "media_discogs_token" MediaDiscogsAPIURL = "media_discogs_api_url" MediaThumbnailMode = "media_thumbnail_mode" MediaThumbnailPath = "media_thumbnail_path" MediaStoreThumbnail = "media_store_thumbnail" MediaScrapeConcurrency = "media_scrape_concurrency" MediaScrapeLanguage = "media_scrape_language" // 首选刮削语言(TMDB / Google Books) MediaBookSource = "media_book_source" // 书籍刮削源:douban/google/openlibrary MediaGoogleBooksKey = "media_google_books_key" // Google Books API Key(可选) MediaDownloadCover = "media_download_cover" // 是否把远程封面下载到本地存储 // media library master switch & protocol switches MediaEnabled = "media_enabled" // 媒体库总开关(PUBLIC,前端据此显示/隐藏) MediaEmbyEnabled = "media_emby_enabled" // Emby 兼容 API 开关 MediaSubsonicEnabled = "media_subsonic_enabled" // OpenSubsonic API 开关 MediaSubsonicProxyStream = "media_subsonic_proxy_stream" // Subsonic 播放是否强制代理(兼容不跟随 302 的客户端) MediaSubsonicAllowPwd = "media_subsonic_allow_password_auth" // Subsonic 是否允许 u+p 使用 OpenList 登录密码认证(默认关闭) MediaProxyCover = "media_proxy_cover" // 是否通过服务端代理外部封面(TMDB/豆瓣等) MediaCoverGateway = "media_cover_gateway" // 封面代理直连失败时是否回退第三方图片网关(wsrv.nl,默认关闭) MediaStrmOnScan = "media_strm_on_scan" // 扫描完成后自动生成 STRM MediaStrmSameDir = "media_strm_same_dir" // STRM 是否与媒体文件同目录(同名 .strm) MediaStrmPath = "media_strm_path" // STRM 输出目录(VFS 路径,仅在指定目录模式下使用) MediaStrmOverwrite = "media_strm_overwrite" // 生成 STRM 时是否覆盖已存在文件 MediaStrmTemplate = "media_strm_template" // STRM 内容模板 // transcode (云端/本地 FFmpeg 转码) TranscodeEnabled = "transcode_enabled" // 总开关,默认关 TranscodeMinSizeGB = "transcode_min_size_gb" // 文件大于多少 GB 才转码 TranscodeMinBitrateMbps = "transcode_min_bitrate_mbps" // 视频码率高于多少 Mbps 才转码(0=不限) TranscodeSourceCodecs = "transcode_source_codecs" // 仅对这些源编码进行转码 TranscodeSourceExtensions = "transcode_source_extensions" // 仅对这些后缀进行转码 TranscodeOutputFormat = "transcode_output_format" // 输出封装格式 hls/dash/mp4 TranscodeOutputCodec = "transcode_output_codec" // 重新编码的视频编码 TranscodeOutputBitrate = "transcode_output_bitrate" // 输出视频码率,例如 4000k TranscodeOutputAudioCodec = "transcode_output_audio_codec" // 输出音频编码 TranscodeOutputAudioBitrate = "transcode_output_audio_bitrate" // 输出音频码率,例如 160k TranscodeOutputResolution = "transcode_output_resolution" // 输出分辨率上限 TranscodeSegmentDuration = "transcode_segment_duration" // HLS 切片时长(秒) TranscodeHWAccel = "transcode_hwaccel" // 硬件加速类型 none/auto/nvenc/qsv/vaapi/amf/videotoolbox TranscodeFFmpegPath = "transcode_ffmpeg_path" // 自定义 ffmpeg 可执行路径 TranscodeFFprobePath = "transcode_ffprobe_path" // 自定义 ffprobe 可执行路径 TranscodeRunMode = "transcode_run_mode" // local / remote / hybrid TranscodeWorkerSecret = "transcode_worker_secret" // 远程 Worker 共享密钥 TranscodeCachePath = "transcode_cache_path" // 切片缓存目录 TranscodeCacheMaxGB = "transcode_cache_max_gb" // 缓存最大占用,超出 LRU 淘汰 TranscodeJobTimeoutMin = "transcode_job_timeout_min" // 单个任务超时分钟 TranscodeLocalConcurrency = "transcode_local_concurrency" // 本地内置 worker 并发数(run_mode=local/hybrid 时生效) TranscodeIdleTimeoutSec = "transcode_idle_timeout_sec" // 播放端无请求多少秒后自动停止转码(默认90秒) // === 智能 chunk 调度相关 === TranscodeChunkDurationSec = "transcode_chunk_duration_sec" // 每个 chunk 时长(秒),将整个视频分成多个 chunk 按需转码(默认60秒) TranscodeMaxChunkConcurrency = "transcode_max_chunk_concurrency" // 单个 Job 最多同时运行的 chunk 数(默认2) TranscodeChunkIdleSec = "transcode_chunk_idle_sec" // chunk 多久没被访问就 kill ffmpeg 释放资源(默认60秒) TranscodeChunkPrefetch = "transcode_chunk_prefetch" // 当前 chunk 转码进度过半时,是否预启动下一个 chunk(默认true) // multipart upload (from main) MultipartEnabled = "multipart_enabled" MultipartChunkSize = "multipart_chunk_size" )
View Source
const ( UNKNOWN = iota FOLDER // OFFICE VIDEO AUDIO TEXT IMAGE )
Variables ¶
View Source
var ( BuiltAt string = "unknown" GitAuthor string = "unknown" GitCommit string = "unknown" Version string = "dev" WebVersion string = "rolling" )
View Source
var ( Conf *Config URL *url.URL ConfigPath string // DataDir 程序数据目录(绝对路径),用于运行时文件(如本地缩略图) DataDir string = "data" )
View Source
var ( // 在HybridCache中使用[]byte缓存数据流的限制,内存为Go自动管理,直到GC AutoMemoryLimit uint64 = 4 * 1024 * 1024 // 最小空闲内存,当内存不足时,HybridCache会回退到文件缓存。 // 如果为0,HybridCache会使用文件缓存,不占用内存。 MinFreeMemory uint64 = 16 * 1024 * 1024 // 限制HybridCache手动管理内存单次的扩容大小,超过该阈值将分多次扩容。 // MinFreeMemory大于0时,也限制 Downloader 的PartSize MaxBlockLimit uint64 = 16 * 1024 * 1024 )
View Source
var ( RawIndexHtml string ManageHtml string IndexHtml string )
View Source
var FilenameCharMap = make(map[string]string)
View Source
var PrivacyReg []*regexp.Regexp
View Source
var SlicesMap = make(map[string][]string)
View Source
var ( // StoragesLoaded loaded success if empty StoragesLoaded = false )
Functions ¶
func ResetStoragesLoadSignal ¶ added in v4.1.5
func ResetStoragesLoadSignal()
func SendStoragesLoadedSignal ¶ added in v4.1.5
func SendStoragesLoadedSignal()
func StoragesLoadSignal ¶ added in v4.1.5
func StoragesLoadSignal() <-chan struct{}
Types ¶
type Config ¶
type Config struct {
Force bool `json:"force" env:"FORCE"`
SiteURL string `json:"site_url" env:"SITE_URL"`
Cdn string `json:"cdn" env:"CDN"`
JwtSecret string `json:"jwt_secret" env:"JWT_SECRET"`
TokenExpiresIn int `json:"token_expires_in" env:"TOKEN_EXPIRES_IN"`
Database Database `json:"database" envPrefix:"DB_"`
Meilisearch Meilisearch `json:"meilisearch" envPrefix:"MEILISEARCH_"`
Scheme Scheme `json:"scheme"`
TempDir string `json:"temp_dir" env:"TEMP_DIR"`
BleveDir string `json:"bleve_dir" env:"BLEVE_DIR"`
DistDir string `json:"dist_dir"`
Log LogConfig `json:"log" envPrefix:"LOG_"`
DelayedStart int `json:"delayed_start" env:"DELAYED_START"`
AutoMemoryLimit int `json:"auto_memory_limit" env:"AUTO_MEMORY_LIMIT"`
MinFreeMemory int `json:"min_free_memory" env:"MIN_FREE_MEMORY"`
MaxBlockLimit int `json:"max_block_limit" env:"MAX_BLOCK_LIMIT"`
MaxConnections int `json:"max_connections" env:"MAX_CONNECTIONS"`
MaxConcurrency int `json:"max_concurrency" env:"MAX_CONCURRENCY"`
TlsInsecureSkipVerify bool `json:"tls_insecure_skip_verify" env:"TLS_INSECURE_SKIP_VERIFY"`
Tasks TasksConfig `json:"tasks" envPrefix:"TASKS_"`
Cors Cors `json:"cors" envPrefix:"CORS_"`
S3 S3 `json:"s3" envPrefix:"S3_"`
FTP FTP `json:"ftp" envPrefix:"FTP_"`
SFTP SFTP `json:"sftp" envPrefix:"SFTP_"`
MCP MCP `json:"mcp" envPrefix:"MCP_"`
LastLaunchedVersion string `json:"last_launched_version"`
ProxyAddress string `json:"proxy_address" env:"PROXY_ADDRESS"`
}
func DefaultConfig ¶
type ContextKey ¶ added in v4.0.9
type ContextKey int8
ContextKey is the type of context keys.
const ( NoTaskKey ContextKey ApiUrlKey UserKey MetaKey MetaPassKey ClientIPKey ProxyHeaderKey RequestHeaderKey UserAgentKey PathKey SharingIDKey SkipHookKey DirectUploadContentTypeKey SkipNoOverwriteKey ThumbnailBaseURLKey )
type Database ¶
type Database struct {
Type string `json:"type" env:"TYPE"`
Host string `json:"host" env:"HOST"`
Port int `json:"port" env:"PORT"`
User string `json:"user" env:"USER"`
Password string `json:"password" env:"PASS"`
Name string `json:"name" env:"NAME"`
DBFile string `json:"db_file" env:"FILE"`
TablePrefix string `json:"table_prefix" env:"TABLE_PREFIX"`
SSLMode string `json:"ssl_mode" env:"SSL_MODE"`
DSN string `json:"dsn" env:"DSN"`
}
type FTP ¶
type FTP struct {
Enable bool `json:"enable" env:"ENABLE"`
Listen string `json:"listen" env:"LISTEN"`
FindPasvPortAttempts int `json:"find_pasv_port_attempts" env:"FIND_PASV_PORT_ATTEMPTS"`
ActiveTransferPortNon20 bool `json:"active_transfer_port_non_20" env:"ACTIVE_TRANSFER_PORT_NON_20"`
IdleTimeout int `json:"idle_timeout" env:"IDLE_TIMEOUT"`
ConnectionTimeout int `json:"connection_timeout" env:"CONNECTION_TIMEOUT"`
DisableActiveMode bool `json:"disable_active_mode" env:"DISABLE_ACTIVE_MODE"`
DefaultTransferBinary bool `json:"default_transfer_binary" env:"DEFAULT_TRANSFER_BINARY"`
EnableActiveConnIPCheck bool `json:"enable_active_conn_ip_check" env:"ENABLE_ACTIVE_CONN_IP_CHECK"`
EnablePasvConnIPCheck bool `json:"enable_pasv_conn_ip_check" env:"ENABLE_PASV_CONN_IP_CHECK"`
}
type LogConfig ¶
type LogConfig struct {
Enable bool `json:"enable" env:"ENABLE"`
Name string `json:"name" env:"NAME"`
MaxSize int `json:"max_size" env:"MAX_SIZE"`
MaxBackups int `json:"max_backups" env:"MAX_BACKUPS"`
MaxAge int `json:"max_age" env:"MAX_AGE"`
Compress bool `json:"compress" env:"COMPRESS"`
Filter LogFilterConfig `json:"filter" envPrefix:"FILTER_"`
}
type LogFilterConfig ¶ added in v4.0.9
type Meilisearch ¶
type Scheme ¶
type Scheme struct {
Address string `json:"address" env:"ADDR"`
HttpPort int `json:"http_port" env:"HTTP_PORT"`
HttpsPort int `json:"https_port" env:"HTTPS_PORT"`
ForceHttps bool `json:"force_https" env:"FORCE_HTTPS"`
CertFile string `json:"cert_file" env:"CERT_FILE"`
KeyFile string `json:"key_file" env:"KEY_FILE"`
UnixFile string `json:"unix_file" env:"UNIX_FILE"`
UnixFilePerm string `json:"unix_file_perm" env:"UNIX_FILE_PERM"`
EnableH2c bool `json:"enable_h2c" env:"ENABLE_H2C"`
EnableH3 bool `json:"enable_h3" env:"ENABLE_H3"`
}
type TaskConfig ¶
type TasksConfig ¶
type TasksConfig struct {
Download TaskConfig `json:"download" envPrefix:"DOWNLOAD_"`
Transfer TaskConfig `json:"transfer" envPrefix:"TRANSFER_"`
Upload TaskConfig `json:"upload" envPrefix:"UPLOAD_"`
Copy TaskConfig `json:"copy" envPrefix:"COPY_"`
Move TaskConfig `json:"move" envPrefix:"MOVE_"`
Decompress TaskConfig `json:"decompress" envPrefix:"DECOMPRESS_"`
DecompressUpload TaskConfig `json:"decompress_upload" envPrefix:"DECOMPRESS_UPLOAD_"`
AllowRetryCanceled bool `json:"allow_retry_canceled" env:"ALLOW_RETRY_CANCELED"`
}
Click to show internal directories.
Click to hide internal directories.