luisgulo/photoprism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

CLI: Revised descriptions of commands and configuration flags

Browse Source
This commit is contained in:
Michael Mayer 2021-10-07 11:43:43 +02:00
parent b72790410f
commit 874af1db61
7 changed files with 48 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
internal/commands/backup.go
View File

@ -22,7 +22,7 @@ import (
// BackupCommand configures the backup cli command.
var BackupCommand = cli.Command{
Name: "backup",
Usage: "Creates album and index backups",
Usage: "Creates index database and album backups",
UsageText: `A custom index sql backup FILENAME may be passed as first argument. Use - for stdout. By default, the backup path is searched.`,
Flags: backupFlags,
Action: backupAction,

2
internal/commands/convert.go
View File

@ -16,7 +16,7 @@ import (
// ConvertCommand registers the convert cli command.
var ConvertCommand = cli.Command{
Name: "convert",
Usage: "Converts media files in other formats to JPEG / AVC",
Usage: "Transcodes files in other formats to JPEG / AVC",
ArgsUsage: "[path]",
Action: convertAction,
}

2
internal/commands/optimize.go
View File

@ -14,7 +14,7 @@ import (
// OptimizeCommand registers the index cli command.
var OptimizeCommand = cli.Command{
Name: "optimize",
Usage: "Performs index metadata maintenance",
Usage: "Performs photo metadata maintenance",
Action: optimizeAction,
}

2
internal/commands/purge.go
View File

@ -20,7 +20,7 @@ import (
// PurgeCommand registers the index cli command.
var PurgeCommand = cli.Command{
Name: "purge",
Usage: "Flags missing files, updates counts and covers",
Usage: "Updates missing files, photo counts, and album covers",
Flags: purgeFlags,
Action: purgeAction,
}

2
internal/commands/restore.go
View File

@ -24,7 +24,7 @@ import (
// RestoreCommand configures the backup cli command.
var RestoreCommand = cli.Command{
Name: "restore",
Usage: "Restores album and index backups",
Usage: "Restores index database and album backups",
UsageText: `A custom index sql backup FILENAME may be passed as first argument. By default, the backup path is searched.`,
Flags: restoreFlags,
Action: restoreAction,

70
internal/config/flags.go
View File

@ -11,12 +11,12 @@ import (
var GlobalFlags = []cli.Flag{
cli.BoolFlag{
Name: "debug",
Usage: "enable debug mode, shows additional log messages",
Usage: "enable debug mode, show additional log messages",
EnvVar: "PHOTOPRISM_DEBUG",
},
cli.StringFlag{
Name: "log-level, l",
Usage: "log verbosity `LEVEL` (trace, debug, info, warning, error, fatal or panic)",
Usage: "trace, debug, info, warning, error, fatal, or panic",
Value: "info",
EnvVar: "PHOTOPRISM_LOG_LEVEL",
},
@ -50,7 +50,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "admin-password",
Usage: "initial admin `PASSWORD`, min 4 characters",
Usage: "initial admin user `PASSWORD`, minimum 4 characters",
EnvVar: "PHOTOPRISM_ADMIN_PASSWORD",
},
cli.BoolFlag{
@ -70,7 +70,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "config-path",
Usage: "config `PATH` where settings and other config files can be found",
Usage: "config `PATH` to be searched for additional configuration and settings files",
EnvVar: "PHOTOPRISM_CONFIG_PATH",
},
cli.StringFlag{
@ -116,12 +116,12 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "assets-path",
Usage: "static assets `PATH` containing resources like icons and templates",
Usage: "assets `PATH` containing static resources like icons, models, and translations",
EnvVar: "PHOTOPRISM_ASSETS_PATH",
},
cli.IntFlag{
Name: "workers, w",
Usage: "max `NUMBER` of indexing workers",
Usage: "maximum `NUMBER` of indexing workers",
EnvVar: "PHOTOPRISM_WORKERS",
Value: cpuid.CPU.PhysicalCores / 2,
},
@ -133,13 +133,13 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "auto-index",
Usage: "WebDAV auto indexing safety delay in `SECONDS` (-1 to disable)",
Usage: "WebDAV auto indexing safety delay in `SECONDS`, disable with -1",
Value: DefaultAutoIndexDelay,
EnvVar: "PHOTOPRISM_AUTO_INDEX",
},
cli.IntFlag{
Name: "auto-import",
Usage: "WebDAV auto import safety delay in `SECONDS` (-1 to disable)",
Usage: "WebDAV auto import safety delay in `SECONDS`, disable with -1",
Value: DefaultAutoImportDelay,
EnvVar: "PHOTOPRISM_AUTO_IMPORT",
},
@ -170,7 +170,7 @@ var GlobalFlags = []cli.Flag{
},
cli.BoolFlag{
Name: "disable-ffmpeg",
Usage: "disable video transcoding and thumbnail generation with FFmpeg",
Usage: "disable video transcoding and still image extraction with FFmpeg",
EnvVar: "PHOTOPRISM_DISABLE_FFMPEG",
},
cli.BoolFlag{
@ -220,7 +220,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "cdn-url",
Usage: "optional content delivery network `URL` (optional)",
Usage: "optional content delivery network `URL`",
EnvVar: "PHOTOPRISM_CDN_URL",
},
cli.StringFlag{
@ -229,14 +229,9 @@ var GlobalFlags = []cli.Flag{
Value: "http://localhost:2342/",
EnvVar: "PHOTOPRISM_SITE_URL",
},
cli.StringFlag{
Name: "site-preview",
Usage: "custom site preview image `URL`",
EnvVar: "PHOTOPRISM_SITE_PREVIEW",
},
cli.StringFlag{
Name: "site-author",
Usage: "site owner or `COPYRIGHT`",
Usage: "site `COPYRIGHT`, artist name, or owner",
EnvVar: "PHOTOPRISM_SITE_AUTHOR",
},
cli.StringFlag{
@ -253,9 +248,14 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "site-description",
Usage: "site `DESCRIPTION`",
Usage: "optional site `DESCRIPTION`",
EnvVar: "PHOTOPRISM_SITE_DESCRIPTION",
},
cli.StringFlag{
Name: "site-preview",
Usage: "optional preview image `URL`",
EnvVar: "PHOTOPRISM_SITE_PREVIEW",
},
cli.IntFlag{
Name: "http-port",
Value: 2342,
@ -274,7 +274,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "http-compression, z",
Usage: "http compression `METHOD` (none or gzip)",
Usage: "http server compression `METHOD` (none or gzip)",
EnvVar: "PHOTOPRISM_HTTP_COMPRESSION",
},
cli.StringFlag{
@ -285,12 +285,12 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "database-dsn",
Usage: "sqlite file name, specifying a `DSN` is optional other drivers",
Usage: "sqlite file name, providing a `DSN` is optional for other drivers",
EnvVar: "PHOTOPRISM_DATABASE_DSN",
},
cli.StringFlag{
Name: "database-server",
Usage: "database server `HOST` and port e.g. mysql:3306",
Usage: "database server `HOST` with optional port e.g. mysql:3306",
EnvVar: "PHOTOPRISM_DATABASE_SERVER",
},
cli.StringFlag{
@ -312,12 +312,12 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "database-conns",
Usage: "max `NUMBER` of open database connections",
Usage: "maximum `NUMBER` of open database connections",
EnvVar: "PHOTOPRISM_DATABASE_CONNS",
},
cli.IntFlag{
Name: "database-conns-idle",
Usage: "max `NUMBER` of idle database connections",
Usage: "maximum `NUMBER` of idle database connections",
EnvVar: "PHOTOPRISM_DATABASE_CONNS_IDLE",
},
cli.BoolFlag{
@ -363,7 +363,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "ffmpeg-bin",
Usage: "FFmpeg `COMMAND` for video transcoding and cover images",
Usage: "FFmpeg `COMMAND` for video transcoding and still image extraction",
Value: "ffmpeg",
EnvVar: "PHOTOPRISM_FFMPEG_BIN",
},
@ -375,7 +375,7 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "ffmpeg-bitrate",
Usage: "max FFmpeg encoding `BITRATE` (Mbit/s)",
Usage: "maximum FFmpeg encoding `BITRATE` (Mbit/s)",
Value: 50,
EnvVar: "PHOTOPRISM_FFMPEG_BITRATE",
},
@ -393,12 +393,12 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "download-token",
Usage: "custom download URL `TOKEN` (generated automatically by default)",
Usage: "custom download URL `TOKEN` (default: randomly generated)",
EnvVar: "PHOTOPRISM_DOWNLOAD_TOKEN",
},
cli.StringFlag{
Name: "preview-token",
Usage: "custom thumbnail and streaming URL `TOKEN` (generated automatically by default)",
Usage: "custom thumbnail and streaming URL `TOKEN` (default: randomly generated)",
EnvVar: "PHOTOPRISM_PREVIEW_TOKEN",
},
cli.StringFlag{
@ -409,7 +409,7 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "thumb-size, s",
Usage: "max pre-cached thumbnail size in `PIXELS` (720-7680)",
Usage: "maximum pre-cached thumbnail image size in `PIXELS` (720-7680)",
Value: 2048,
EnvVar: "PHOTOPRISM_THUMB_SIZE",
},
@ -420,31 +420,31 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "thumb-size-uncached, x",
Usage: "max on-demand thumbnail size in `PIXELS` (720-7680)",
Usage: "maximum size of on-demand generated thumbnails in `PIXELS` (720-7680)",
Value: 7680,
EnvVar: "PHOTOPRISM_THUMB_SIZE_UNCACHED",
},
cli.IntFlag{
Name: "jpeg-size",
Usage: "max size of generated JPEG files in `PIXELS` (720-30000)",
Usage: "maximum size of generated JPEG images in `PIXELS` (720-30000)",
Value: 7680,
EnvVar: "PHOTOPRISM_JPEG_SIZE",
},
cli.IntFlag{
Name: "jpeg-quality, q",
Usage: "`QUALITY` of generated JPEG files, a higher value reduces compression (25-100)",
Usage: "`QUALITY` of generated JPEG images, a higher value reduces compression (25-100)",
Value: 92,
EnvVar: "PHOTOPRISM_JPEG_QUALITY",
},
cli.IntFlag{
Name: "face-size",
Usage: "min face size in `PIXELS`",
Usage: "minimum face size in `PIXELS`",
Value: face.SizeThreshold,
EnvVar: "PHOTOPRISM_FACE_SIZE",
},
cli.Float64Flag{
Name: "face-score",
Usage: "quality `THRESHOLD` for faces",
Usage: "minimum face `QUALITY` score",
Value: face.ScoreThreshold,
EnvVar: "PHOTOPRISM_FACE_SCORE",
},
@ -456,13 +456,13 @@ var GlobalFlags = []cli.Flag{
},
cli.IntFlag{
Name: "face-cluster-size",
Usage: "min size of faces forming a cluster in `PIXELS`",
Usage: "minimum size of automatically clustered faces in `PIXELS`",
Value: face.ClusterSizeThreshold,
EnvVar: "PHOTOPRISM_FACE_CLUSTER_SIZE",
},
cli.IntFlag{
Name: "face-cluster-score",
Usage: "quality `THRESHOLD` for faces forming a cluster",
Usage: "minimum `QUALITY` score of automatically clustered faces",
Value: face.ClusterScoreThreshold,
EnvVar: "PHOTOPRISM_FACE_CLUSTER_SCORE",
},
@ -486,7 +486,7 @@ var GlobalFlags = []cli.Flag{
},
cli.StringFlag{
Name: "pid-filename",
Usage: "daemon process id `FILENAME`",
Usage: "process id `FILENAME` when running in daemon mode",
EnvVar: "PHOTOPRISM_PID_FILENAME",
},
}

25
internal/face/children_test.go
View File

File diff suppressed because one or more lines are too long