beenull/photoprism
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Config: Tag advanced options for documentation purposes

Browse source 
Signed-off-by: Michael Mayer <michael@photoprism.app>
This commit is contained in:
Michael Mayer 2023-05-01 18:32:37 +02:00
parent c30423a3c1
commit c405f6eff2
3 changed files with 24 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
internal/config/cli_flag.go
View file

@ -72,6 +72,10 @@ func (f CliFlag) CommandFlag() string {
func (f CliFlag) Usage() string {
if list.Contains(f.Tags, EnvSponsor) {
return f.Flag.GetUsage() + " *members only*"
} else if list.Contains(f.Tags, Essentials) {
return f.Flag.GetUsage() + " *essentials*"
} else if list.Contains(f.Tags, Plus) {
return f.Flag.GetUsage() + " *plus*"
} else {
return f.Flag.GetUsage()
}

3
internal/config/config_const.go
View file

@ -55,3 +55,6 @@ const DefaultSessionMaxAge = UnixWeek * 2
// DefaultSessionTimeout is the default session timeout time in seconds.
const DefaultSessionTimeout = UnixWeek
const Essentials = "essentials"
const Plus = "plus"

34
internal/config/flags.go
View file

@ -328,14 +328,14 @@ var Flags = CliFlags{
Usage: "standard user interface theme `NAME`",
EnvVar: EnvVar("DEFAULT_THEME"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "app-name",
Usage: "progressive web app `NAME` when installed on a device",
Value: "",
EnvVar: EnvVar("APP_NAME"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "app-mode",
Usage: "progressive web app `MODE` (fullscreen, standalone, minimal-ui, browser)",
@ -347,7 +347,7 @@ var Flags = CliFlags{
Usage: "home screen `ICON` (logo, app, crisp, mint, bold, square)",
EnvVar: EnvVar("APP_ICON"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "app-color",
Usage: "splash screen `COLOR` code",
@ -361,14 +361,14 @@ var Flags = CliFlags{
Hidden: true,
EnvVar: EnvVar("IMPRINT"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "legal-info",
Usage: "legal information `TEXT`, displayed in the page footer",
Value: "",
EnvVar: EnvVar("LEGAL_INFO"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "imprint-url",
Usage: "legal information `URL`",
@ -376,14 +376,14 @@ var Flags = CliFlags{
Hidden: true,
EnvVar: EnvVar("IMPRINT_URL"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "legal-url",
Usage: "legal information `URL`",
Value: "",
EnvVar: EnvVar("LEGAL_URL"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "wallpaper-uri",
Usage: "login screen background image `URI`",
@ -395,13 +395,13 @@ var Flags = CliFlags{
Usage: "content delivery network `URL`",
EnvVar: EnvVar("CDN_URL"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.BoolFlag{
Name: "cdn-video",
Usage: "stream videos over the specified CDN",
EnvVar: EnvVar("CDN_VIDEO"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "site-url, url",
Usage: "public site `URL`",
@ -419,7 +419,7 @@ var Flags = CliFlags{
Value: "",
EnvVar: EnvVar("SITE_TITLE"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "site-caption",
Usage: "site `CAPTION`",
@ -435,7 +435,7 @@ var Flags = CliFlags{
Name: "site-preview",
Usage: "sharing preview image `URL`",
EnvVar: EnvVar("SITE_PREVIEW"),
}, Tags: []string{EnvSponsor}}, {
}, Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "https-proxy",
Usage: "proxy server `URL` to be used for outgoing connections *optional*",
@ -584,7 +584,7 @@ var Flags = CliFlags{
Value: "libx264",
EnvVar: EnvVar("FFMPEG_ENCODER"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.IntFlag{
Name: "ffmpeg-bitrate, vb",
Usage: "maximum FFmpeg encoding `BITRATE` (Mbit/s)",
@ -743,34 +743,34 @@ var Flags = CliFlags{
Usage: "minimum size of automatically clustered faces in `PIXELS` (20-10000)",
Value: face.ClusterSizeThreshold,
EnvVar: EnvVar("FACE_CLUSTER_SIZE"),
}, Tags: []string{EnvSponsor}}, {
}, Tags: []string{Essentials}}, {
Flag: cli.IntFlag{
Name: "face-cluster-score",
Usage: "minimum `QUALITY` score of automatically clustered faces (1-100)",
Value: face.ClusterScoreThreshold,
EnvVar: EnvVar("FACE_CLUSTER_SCORE"),
}, Tags: []string{EnvSponsor}}, {
}, Tags: []string{Essentials}}, {
Flag: cli.IntFlag{
Name: "face-cluster-core",
Usage: "`NUMBER` of faces forming a cluster core (1-100)",
Value: face.ClusterCore,
EnvVar: EnvVar("FACE_CLUSTER_CORE"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.Float64Flag{
Name: "face-cluster-dist",
Usage: "similarity `DISTANCE` of faces forming a cluster core (0.1-1.5)",
Value: face.ClusterDist,
EnvVar: EnvVar("FACE_CLUSTER_DIST"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.Float64Flag{
Name: "face-match-dist",
Usage: "similarity `OFFSET` for matching faces with existing clusters (0.1-1.5)",
Value: face.MatchDist,
EnvVar: EnvVar("FACE_MATCH_DIST"),
},
Tags: []string{EnvSponsor}}, {
Tags: []string{Essentials}}, {
Flag: cli.StringFlag{
Name: "pid-filename",
Usage: "process id `FILE` *daemon-mode only*",