mirror of
https://github.com/xuthus83/pigallery2.git
synced 2024-11-03 21:04:03 +08:00
Updating MANPAGE.md
This commit is contained in:
parent
c6640ce0f4
commit
6cc171c7f5
365
MANPAGE.md
365
MANPAGE.md
@ -36,20 +36,17 @@ App CLI options:
|
|||||||
--Server-Media-Video-transcoding-fps (default: 25)
|
--Server-Media-Video-transcoding-fps (default: 25)
|
||||||
--Server-Media-Video-transcoding-codec (default: 'libx264')
|
--Server-Media-Video-transcoding-codec (default: 'libx264')
|
||||||
--Server-Media-Video-transcoding-format (default: 'mp4')
|
--Server-Media-Video-transcoding-format (default: 'mp4')
|
||||||
--Server-Media-Video-transcoding-crf Constant Rate Factor. The range of the CRF scale is 0–51, where 0 is lossless, 23 is the default, and 51 i
|
--Server-Media-Video-transcoding-crf Constant Rate Factor. The range of the CRF scale is 0–51, where 0 is lossless, 23 is the default, and 51 is worst quality possible. (default: 23)
|
||||||
s worst quality possible. (default: 23)
|
--Server-Media-Video-transcoding-preset A preset is a collection of options that will provide a certain encoding speed to compression ratio (default: 'medium')
|
||||||
--Server-Media-Video-transcoding-preset A preset is a collection of options that will provide a certain encoding speed to compression ratio (defau
|
|
||||||
lt: 'medium')
|
|
||||||
--Server-Media-Video-transcoding-customOptions It will be sent to ffmpeg as it is, as custom options. (default: [])
|
--Server-Media-Video-transcoding-customOptions It will be sent to ffmpeg as it is, as custom options. (default: [])
|
||||||
--Server-Media-Photo-Converting-onTheFly Converts photos on the fly, when they are requested. (default: true)
|
--Server-Media-Photo-Converting-onTheFly Converts photos on the fly, when they are requested. (default: true)
|
||||||
--Server-Media-Photo-Converting-resolution (default: 1080)
|
--Server-Media-Photo-Converting-resolution (default: 1080)
|
||||||
--Server-Media-Thumbnail-qualityPriority if true, photos will have better quality. (default: true)
|
--Server-Media-Thumbnail-qualityPriority if true, photos will have better quality. (default: true)
|
||||||
--Server-Media-Thumbnail-personFaceMargin (default: 0.6)
|
--Server-Media-Thumbnail-personFaceMargin (default: 0.6)
|
||||||
--Server-Preview-SearchQuery (default: null)
|
--Server-Preview-SearchQuery (default: {"type":100,"text":""})
|
||||||
--Server-Preview-Sorting (default: [6,4])
|
--Server-Preview-Sorting (default: [6,4])
|
||||||
--Server-Threading-enabled App can run on multiple thread (default: true)
|
--Server-Threading-enabled App can run on multiple thread (default: true)
|
||||||
--Server-Threading-thumbnailThreads Number of threads that are used to generate thumbnails. If 0, number of 'CPU cores -1' threads will be use
|
--Server-Threading-thumbnailThreads Number of threads that are used to generate thumbnails. If 0, number of 'CPU cores -1' threads will be used. (default: 0)
|
||||||
d. (default: 0)
|
|
||||||
--Server-Database-type (default: 'sqlite')
|
--Server-Database-type (default: 'sqlite')
|
||||||
--Server-Database-dbFolder (default: 'db')
|
--Server-Database-dbFolder (default: 'db')
|
||||||
--Server-Database-sqlite-DBFileName (default: 'sqlite.db')
|
--Server-Database-sqlite-DBFileName (default: 'sqlite.db')
|
||||||
@ -58,38 +55,32 @@ d. (default: 0)
|
|||||||
--Server-Database-mysql-database (default: 'pigallery2')
|
--Server-Database-mysql-database (default: 'pigallery2')
|
||||||
--Server-Database-mysql-username (default: '')
|
--Server-Database-mysql-username (default: '')
|
||||||
--Server-Database-mysql-password (default: '')
|
--Server-Database-mysql-password (default: '')
|
||||||
--Server-Database-enforcedUsers (default: [{"name":"admin","role":4,"password":"admin"}])
|
--Server-Database-enforcedUsers Creates these users in the DB if they do not exist. If a user with this name exist, it wont be overwritten, even if the role is different. (default: [])
|
||||||
--Server-Sharing-updateTimeout (default: 300000)
|
--Server-Sharing-updateTimeout (default: 300000)
|
||||||
--Server-sessionTimeout unit: ms (default: 604800000)
|
--Server-sessionTimeout unit: ms (default: 604800000)
|
||||||
--Server-Indexing-cachedFolderTimeout (default: 3600000)
|
--Server-Indexing-cachedFolderTimeout (default: 3600000)
|
||||||
--Server-Indexing-reIndexingSensitivity (default: 'low')
|
--Server-Indexing-reIndexingSensitivity (default: 'low')
|
||||||
--Server-Indexing-excludeFolderList If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a
|
--Server-Indexing-excludeFolderList If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded. (default: [".Trash-1000",".dtrash","$RECYCLE.BIN"])
|
||||||
'/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded. (default: [".Trash-1000",".dtrash","$R
|
|
||||||
ECYCLE.BIN"])
|
|
||||||
--Server-Indexing-excludeFileList Any folder that contains a file with this name will be excluded from indexing. (default: [])
|
--Server-Indexing-excludeFileList Any folder that contains a file with this name will be excluded from indexing. (default: [])
|
||||||
--Server-photoMetadataSize only this many bites will be loaded when scanning photo for metadata (default: 524288)
|
--Server-photoMetadataSize only this many bites will be loaded when scanning photo for metadata (default: 524288)
|
||||||
--Server-Duplicates-listingLimit (default: 1000)
|
--Server-Duplicates-listingLimit (default: 1000)
|
||||||
--Server-Log-level (default: 'info')
|
--Server-Log-level (default: 'info')
|
||||||
--Server-Log-sqlLevel (default: 'error')
|
--Server-Log-sqlLevel (default: 'error')
|
||||||
|
--Server-Log-logServerTiming (default: false)
|
||||||
--Server-Jobs-maxSavedProgress Job history size (default: 10)
|
--Server-Jobs-maxSavedProgress Job history size (default: 10)
|
||||||
--Server-Jobs-scheduled (default: [{"name":"Indexing","jobName":"Indexing","config":{"indexChangesOnly":true},"allowParallelRun":
|
--Server-Jobs-scheduled (default: [{"name":"Indexing","jobName":"Indexing","config":{"indexChangesOnly":true},"allowParallelRun":false,"trigger":{"type":1}},{"name":"Preview Filling","jobName":"Preview Filling","config":{},"allowParallelRun":false,"trigger":{"type":1}},{"name":"Thumbnail Generation","jobName":"Thumbnail Generation","config":{"sizes":[240],"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Preview Filling"}},{"name":"Photo Converting","jobName":"Photo Converting","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Thumbnail Generation"}},{"name":"Video Converting","jobName":"Video Converting","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Photo Converting"}},{"name":"Temp Folder Cleaning","jobName":"Temp Folder Cleaning","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Video Converting"}}])
|
||||||
false,"trigger":{"type":1}},{"name":"Thumbnail Generation","jobName":"Thumbnail Generation","config":{"sizes":[240],"indexedOnly":true},"allowParallelRun":false,"
|
|
||||||
trigger":{"type":4,"afterScheduleName":"Indexing"}},{"name":"Photo Converting","jobName":"Photo Converting","config":{"indexedOnly":true},"allowParallelRun":false
|
|
||||||
,"trigger":{"type":4,"afterScheduleName":"Thumbnail Generation"}},{"name":"Video Converting","jobName":"Video Converting","config":{"indexedOnly":true},"allowPara
|
|
||||||
llelRun":false,"trigger":{"type":4,"afterScheduleName":"Photo Converting"}},{"name":"Temp Folder Cleaning","jobName":"Temp Folder Cleaning","config":{"indexedOnly
|
|
||||||
":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Video Converting"}}])
|
|
||||||
--Client-applicationTitle (default: 'PiGallery 2')
|
--Client-applicationTitle (default: 'PiGallery 2')
|
||||||
--Client-publicUrl (default: '')
|
--Client-publicUrl (default: '')
|
||||||
--Client-urlBase (default: '')
|
--Client-urlBase (default: '')
|
||||||
--Client-Search-enabled (default: true)
|
--Client-Search-enabled (default: true)
|
||||||
--Client-Search-searchCacheTimeout (default: 3600000)
|
--Client-Search-searchCacheTimeout (default: 3600000)
|
||||||
--Client-Search-AutoComplete-enabled (default: true)
|
--Client-Search-AutoComplete-enabled (default: true)
|
||||||
--Client-Search-AutoComplete-maxItemsPerCategory (default: 5)
|
--Client-Search-AutoComplete-targetItemsPerCategory (default: 5)
|
||||||
|
--Client-Search-AutoComplete-maxItems (default: 30)
|
||||||
--Client-Search-AutoComplete-cacheTimeout (default: 3600000)
|
--Client-Search-AutoComplete-cacheTimeout (default: 3600000)
|
||||||
--Client-Search-maxMediaResult (default: 10000)
|
--Client-Search-maxMediaResult (default: 10000)
|
||||||
--Client-Search-listDirectories Search returns also with directories, not just media (default: false)
|
--Client-Search-listDirectories Search returns also with directories, not just media (default: false)
|
||||||
--Client-Search-listMetafiles Search also returns with metafiles from directories that contain a media file of the matched search result
|
--Client-Search-listMetafiles Search also returns with metafiles from directories that contain a media file of the matched search result (default: true)
|
||||||
(default: true)
|
|
||||||
--Client-Search-maxDirectoryResult (default: 200)
|
--Client-Search-maxDirectoryResult (default: 200)
|
||||||
--Client-Sharing-enabled (default: true)
|
--Client-Sharing-enabled (default: true)
|
||||||
--Client-Sharing-passwordProtected (default: true)
|
--Client-Sharing-passwordProtected (default: true)
|
||||||
@ -100,16 +91,17 @@ llelRun":false,"trigger":{"type":4,"afterScheduleName":"Photo Converting"}},{"na
|
|||||||
--Client-Map-mapProvider (default: 'OpenStreetMap')
|
--Client-Map-mapProvider (default: 'OpenStreetMap')
|
||||||
--Client-Map-mapboxAccessToken (default: '')
|
--Client-Map-mapboxAccessToken (default: '')
|
||||||
--Client-Map-customLayers (default: [{"name":"street","url":""}])
|
--Client-Map-customLayers (default: [{"name":"street","url":""}])
|
||||||
--Client-RandomPhoto-enabled (default: true)
|
--Client-RandomPhoto-enabled Enables random link generation. NOTE: With the current implementation, it poses a security risk. See https://github.com/bpatrik/pigallery2/issues/392 (default: false)
|
||||||
|
--Client-Other-customHTMLHead (default: '')
|
||||||
--Client-Other-enableCache (default: true)
|
--Client-Other-enableCache (default: true)
|
||||||
--Client-Other-enableOnScrollRendering (default: true)
|
--Client-Other-enableOnScrollRendering (default: true)
|
||||||
--Client-Other-defaultPhotoSortingMethod (default: 'ascDate')
|
--Client-Other-defaultPhotoSortingMethod (default: 'ascDate')
|
||||||
--Client-Other-enableDirectorySortingByDate If enabled directories will be sorted by date, like photos, otherwise by name. Directory date is the last
|
--Client-Other-enableDirectorySortingByDate If enabled directories will be sorted by date, like photos, otherwise by name. Directory date is the last modification time of that directory not the creation date of the oldest photo (default: false)
|
||||||
modification time of that directory not the creation date of the oldest photo (default: false)
|
|
||||||
--Client-Other-enableOnScrollThumbnailPrioritising (default: true)
|
--Client-Other-enableOnScrollThumbnailPrioritising (default: true)
|
||||||
--Client-Other-NavBar-showItemCount (default: true)
|
--Client-Other-NavBar-showItemCount (default: true)
|
||||||
--Client-Other-captionFirstNaming (default: false)
|
--Client-Other-captionFirstNaming (default: false)
|
||||||
--Client-Other-enableDownloadZip (default: false)
|
--Client-Other-enableDownloadZip (default: false)
|
||||||
|
--Client-Other-enableDirectoryFlattening Adds a button to flattens the file structure, by listing the content of all subdirectories. (default: false)
|
||||||
--Client-authenticationRequired (default: true)
|
--Client-authenticationRequired (default: true)
|
||||||
--Client-unAuthenticatedUserRole (default: 'Admin')
|
--Client-unAuthenticatedUserRole (default: 'Admin')
|
||||||
--Client-Media-Thumbnail-iconSize (default: 45)
|
--Client-Media-Thumbnail-iconSize (default: 45)
|
||||||
@ -118,9 +110,9 @@ modification time of that directory not the creation date of the oldest photo (d
|
|||||||
--Client-Media-Video-enabled (default: true)
|
--Client-Media-Video-enabled (default: true)
|
||||||
--Client-Media-Photo-Converting-enabled (default: true)
|
--Client-Media-Photo-Converting-enabled (default: true)
|
||||||
--Client-Media-Photo-loadFullImageOnZoom Enables loading the full resolution image on zoom in the ligthbox (preview). (default: true)
|
--Client-Media-Photo-loadFullImageOnZoom Enables loading the full resolution image on zoom in the ligthbox (preview). (default: true)
|
||||||
--Client-MetaFile-gpx Reads *.gpx files and renders them on the map (default: true)
|
--Client-MetaFile-gpx Reads *.gpx files and renders them on the map. (default: true)
|
||||||
--Client-MetaFile-markdown Reads *.md files in a directory and shows the next to the map (default: true)
|
--Client-MetaFile-markdown Reads *.md files in a directory and shows the next to the map. (default: true)
|
||||||
--Client-MetaFile-pg2conf Reads *.pg2conf files (default: true)
|
--Client-MetaFile-pg2conf Reads *.pg2conf files (You can use it for custom sorting and save search (albums)). (default: true)
|
||||||
--Client-Faces-enabled (default: true)
|
--Client-Faces-enabled (default: true)
|
||||||
--Client-Faces-keywordsToPersons (default: true)
|
--Client-Faces-keywordsToPersons (default: true)
|
||||||
--Client-Faces-writeAccessMinRole (default: 'Admin')
|
--Client-Faces-writeAccessMinRole (default: 'Admin')
|
||||||
@ -138,20 +130,17 @@ Environmental variables:
|
|||||||
Server-Media-Video-transcoding-fps (default: 25)
|
Server-Media-Video-transcoding-fps (default: 25)
|
||||||
Server-Media-Video-transcoding-codec (default: 'libx264')
|
Server-Media-Video-transcoding-codec (default: 'libx264')
|
||||||
Server-Media-Video-transcoding-format (default: 'mp4')
|
Server-Media-Video-transcoding-format (default: 'mp4')
|
||||||
Server-Media-Video-transcoding-crf Constant Rate Factor. The range of the CRF scale is 0–51, where 0 is lossless, 23 is the default, and 51 is wo
|
Server-Media-Video-transcoding-crf Constant Rate Factor. The range of the CRF scale is 0–51, where 0 is lossless, 23 is the default, and 51 is worst quality possible. (default: 23)
|
||||||
rst quality possible. (default: 23)
|
Server-Media-Video-transcoding-preset A preset is a collection of options that will provide a certain encoding speed to compression ratio (default: 'medium')
|
||||||
Server-Media-Video-transcoding-preset A preset is a collection of options that will provide a certain encoding speed to compression ratio (default:
|
|
||||||
'medium')
|
|
||||||
Server-Media-Video-transcoding-customOptions It will be sent to ffmpeg as it is, as custom options. (default: [])
|
Server-Media-Video-transcoding-customOptions It will be sent to ffmpeg as it is, as custom options. (default: [])
|
||||||
Server-Media-Photo-Converting-onTheFly Converts photos on the fly, when they are requested. (default: true)
|
Server-Media-Photo-Converting-onTheFly Converts photos on the fly, when they are requested. (default: true)
|
||||||
Server-Media-Photo-Converting-resolution (default: 1080)
|
Server-Media-Photo-Converting-resolution (default: 1080)
|
||||||
Server-Media-Thumbnail-qualityPriority if true, photos will have better quality. (default: true)
|
Server-Media-Thumbnail-qualityPriority if true, photos will have better quality. (default: true)
|
||||||
Server-Media-Thumbnail-personFaceMargin (default: 0.6)
|
Server-Media-Thumbnail-personFaceMargin (default: 0.6)
|
||||||
Server-Preview-SearchQuery (default: null)
|
Server-Preview-SearchQuery (default: {"type":100,"text":""})
|
||||||
Server-Preview-Sorting (default: [6,4])
|
Server-Preview-Sorting (default: [6,4])
|
||||||
Server-Threading-enabled App can run on multiple thread (default: true)
|
Server-Threading-enabled App can run on multiple thread (default: true)
|
||||||
Server-Threading-thumbnailThreads Number of threads that are used to generate thumbnails. If 0, number of 'CPU cores -1' threads will be used. (
|
Server-Threading-thumbnailThreads Number of threads that are used to generate thumbnails. If 0, number of 'CPU cores -1' threads will be used. (default: 0)
|
||||||
default: 0)
|
|
||||||
Server-Database-type (default: 'sqlite')
|
Server-Database-type (default: 'sqlite')
|
||||||
Server-Database-dbFolder (default: 'db')
|
Server-Database-dbFolder (default: 'db')
|
||||||
Server-Database-sqlite-DBFileName (default: 'sqlite.db')
|
Server-Database-sqlite-DBFileName (default: 'sqlite.db')
|
||||||
@ -165,38 +154,32 @@ default: 0)
|
|||||||
MYSQL_USERNAME same as Server-Database-mysql-username
|
MYSQL_USERNAME same as Server-Database-mysql-username
|
||||||
Server-Database-mysql-password (default: '')
|
Server-Database-mysql-password (default: '')
|
||||||
MYSQL_PASSWORD same as Server-Database-mysql-password
|
MYSQL_PASSWORD same as Server-Database-mysql-password
|
||||||
Server-Database-enforcedUsers (default: [{"name":"admin","role":4,"password":"admin"}])
|
Server-Database-enforcedUsers Creates these users in the DB if they do not exist. If a user with this name exist, it wont be overwritten, even if the role is different. (default: [])
|
||||||
Server-Sharing-updateTimeout (default: 300000)
|
Server-Sharing-updateTimeout (default: 300000)
|
||||||
Server-sessionTimeout unit: ms (default: 604800000)
|
Server-sessionTimeout unit: ms (default: 604800000)
|
||||||
Server-Indexing-cachedFolderTimeout (default: 3600000)
|
Server-Indexing-cachedFolderTimeout (default: 3600000)
|
||||||
Server-Indexing-reIndexingSensitivity (default: 'low')
|
Server-Indexing-reIndexingSensitivity (default: 'low')
|
||||||
Server-Indexing-excludeFolderList If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/'
|
Server-Indexing-excludeFolderList If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded. (default: [".Trash-1000",".dtrash","$RECYCLE.BIN"])
|
||||||
, the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded. (default: [".Trash-1000",".dtrash","$RECYC
|
|
||||||
LE.BIN"])
|
|
||||||
Server-Indexing-excludeFileList Any folder that contains a file with this name will be excluded from indexing. (default: [])
|
Server-Indexing-excludeFileList Any folder that contains a file with this name will be excluded from indexing. (default: [])
|
||||||
Server-photoMetadataSize only this many bites will be loaded when scanning photo for metadata (default: 524288)
|
Server-photoMetadataSize only this many bites will be loaded when scanning photo for metadata (default: 524288)
|
||||||
Server-Duplicates-listingLimit (default: 1000)
|
Server-Duplicates-listingLimit (default: 1000)
|
||||||
Server-Log-level (default: 'info')
|
Server-Log-level (default: 'info')
|
||||||
Server-Log-sqlLevel (default: 'error')
|
Server-Log-sqlLevel (default: 'error')
|
||||||
|
Server-Log-logServerTiming (default: false)
|
||||||
Server-Jobs-maxSavedProgress Job history size (default: 10)
|
Server-Jobs-maxSavedProgress Job history size (default: 10)
|
||||||
Server-Jobs-scheduled (default: [{"name":"Indexing","jobName":"Indexing","config":{"indexChangesOnly":true},"allowParallelRun":fals
|
Server-Jobs-scheduled (default: [{"name":"Indexing","jobName":"Indexing","config":{"indexChangesOnly":true},"allowParallelRun":false,"trigger":{"type":1}},{"name":"Preview Filling","jobName":"Preview Filling","config":{},"allowParallelRun":false,"trigger":{"type":1}},{"name":"Thumbnail Generation","jobName":"Thumbnail Generation","config":{"sizes":[240],"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Preview Filling"}},{"name":"Photo Converting","jobName":"Photo Converting","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Thumbnail Generation"}},{"name":"Video Converting","jobName":"Video Converting","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Photo Converting"}},{"name":"Temp Folder Cleaning","jobName":"Temp Folder Cleaning","config":{"indexedOnly":true},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Video Converting"}}])
|
||||||
e,"trigger":{"type":1}},{"name":"Thumbnail Generation","jobName":"Thumbnail Generation","config":{"sizes":[240],"indexedOnly":true},"allowParallelRun":false,"trig
|
|
||||||
ger":{"type":4,"afterScheduleName":"Indexing"}},{"name":"Photo Converting","jobName":"Photo Converting","config":{"indexedOnly":true},"allowParallelRun":false,"tr
|
|
||||||
igger":{"type":4,"afterScheduleName":"Thumbnail Generation"}},{"name":"Video Converting","jobName":"Video Converting","config":{"indexedOnly":true},"allowParallel
|
|
||||||
Run":false,"trigger":{"type":4,"afterScheduleName":"Photo Converting"}},{"name":"Temp Folder Cleaning","jobName":"Temp Folder Cleaning","config":{"indexedOnly":tr
|
|
||||||
ue},"allowParallelRun":false,"trigger":{"type":4,"afterScheduleName":"Video Converting"}}])
|
|
||||||
Client-applicationTitle (default: 'PiGallery 2')
|
Client-applicationTitle (default: 'PiGallery 2')
|
||||||
Client-publicUrl (default: '')
|
Client-publicUrl (default: '')
|
||||||
Client-urlBase (default: '')
|
Client-urlBase (default: '')
|
||||||
Client-Search-enabled (default: true)
|
Client-Search-enabled (default: true)
|
||||||
Client-Search-searchCacheTimeout (default: 3600000)
|
Client-Search-searchCacheTimeout (default: 3600000)
|
||||||
Client-Search-AutoComplete-enabled (default: true)
|
Client-Search-AutoComplete-enabled (default: true)
|
||||||
Client-Search-AutoComplete-maxItemsPerCategory (default: 5)
|
Client-Search-AutoComplete-targetItemsPerCategory (default: 5)
|
||||||
|
Client-Search-AutoComplete-maxItems (default: 30)
|
||||||
Client-Search-AutoComplete-cacheTimeout (default: 3600000)
|
Client-Search-AutoComplete-cacheTimeout (default: 3600000)
|
||||||
Client-Search-maxMediaResult (default: 10000)
|
Client-Search-maxMediaResult (default: 10000)
|
||||||
Client-Search-listDirectories Search returns also with directories, not just media (default: false)
|
Client-Search-listDirectories Search returns also with directories, not just media (default: false)
|
||||||
Client-Search-listMetafiles Search also returns with metafiles from directories that contain a media file of the matched search result (de
|
Client-Search-listMetafiles Search also returns with metafiles from directories that contain a media file of the matched search result (default: true)
|
||||||
fault: true)
|
|
||||||
Client-Search-maxDirectoryResult (default: 200)
|
Client-Search-maxDirectoryResult (default: 200)
|
||||||
Client-Sharing-enabled (default: true)
|
Client-Sharing-enabled (default: true)
|
||||||
Client-Sharing-passwordProtected (default: true)
|
Client-Sharing-passwordProtected (default: true)
|
||||||
@ -207,16 +190,17 @@ fault: true)
|
|||||||
Client-Map-mapProvider (default: 'OpenStreetMap')
|
Client-Map-mapProvider (default: 'OpenStreetMap')
|
||||||
Client-Map-mapboxAccessToken (default: '')
|
Client-Map-mapboxAccessToken (default: '')
|
||||||
Client-Map-customLayers (default: [{"name":"street","url":""}])
|
Client-Map-customLayers (default: [{"name":"street","url":""}])
|
||||||
Client-RandomPhoto-enabled (default: true)
|
Client-RandomPhoto-enabled Enables random link generation. NOTE: With the current implementation, it poses a security risk. See https://github.com/bpatrik/pigallery2/issues/392 (default: false)
|
||||||
|
Client-Other-customHTMLHead (default: '')
|
||||||
Client-Other-enableCache (default: true)
|
Client-Other-enableCache (default: true)
|
||||||
Client-Other-enableOnScrollRendering (default: true)
|
Client-Other-enableOnScrollRendering (default: true)
|
||||||
Client-Other-defaultPhotoSortingMethod (default: 'ascDate')
|
Client-Other-defaultPhotoSortingMethod (default: 'ascDate')
|
||||||
Client-Other-enableDirectorySortingByDate If enabled directories will be sorted by date, like photos, otherwise by name. Directory date is the last modi
|
Client-Other-enableDirectorySortingByDate If enabled directories will be sorted by date, like photos, otherwise by name. Directory date is the last modification time of that directory not the creation date of the oldest photo (default: false)
|
||||||
fication time of that directory not the creation date of the oldest photo (default: false)
|
|
||||||
Client-Other-enableOnScrollThumbnailPrioritising (default: true)
|
Client-Other-enableOnScrollThumbnailPrioritising (default: true)
|
||||||
Client-Other-NavBar-showItemCount (default: true)
|
Client-Other-NavBar-showItemCount (default: true)
|
||||||
Client-Other-captionFirstNaming (default: false)
|
Client-Other-captionFirstNaming (default: false)
|
||||||
Client-Other-enableDownloadZip (default: false)
|
Client-Other-enableDownloadZip (default: false)
|
||||||
|
Client-Other-enableDirectoryFlattening Adds a button to flattens the file structure, by listing the content of all subdirectories. (default: false)
|
||||||
Client-authenticationRequired (default: true)
|
Client-authenticationRequired (default: true)
|
||||||
Client-unAuthenticatedUserRole (default: 'Admin')
|
Client-unAuthenticatedUserRole (default: 'Admin')
|
||||||
Client-Media-Thumbnail-iconSize (default: 45)
|
Client-Media-Thumbnail-iconSize (default: 45)
|
||||||
@ -225,11 +209,288 @@ fication time of that directory not the creation date of the oldest photo (defau
|
|||||||
Client-Media-Video-enabled (default: true)
|
Client-Media-Video-enabled (default: true)
|
||||||
Client-Media-Photo-Converting-enabled (default: true)
|
Client-Media-Photo-Converting-enabled (default: true)
|
||||||
Client-Media-Photo-loadFullImageOnZoom Enables loading the full resolution image on zoom in the ligthbox (preview). (default: true)
|
Client-Media-Photo-loadFullImageOnZoom Enables loading the full resolution image on zoom in the ligthbox (preview). (default: true)
|
||||||
Client-MetaFile-gpx Reads *.gpx files and renders them on the map (default: true)
|
Client-MetaFile-gpx Reads *.gpx files and renders them on the map. (default: true)
|
||||||
Client-MetaFile-markdown Reads *.md files in a directory and shows the next to the map (default: true)
|
Client-MetaFile-markdown Reads *.md files in a directory and shows the next to the map. (default: true)
|
||||||
Client-MetaFile-pg2conf Reads *.pg2conf files (default: true)
|
Client-MetaFile-pg2conf Reads *.pg2conf files (You can use it for custom sorting and save search (albums)). (default: true)
|
||||||
Client-Faces-enabled (default: true)
|
Client-Faces-enabled (default: true)
|
||||||
Client-Faces-keywordsToPersons (default: true)
|
Client-Faces-keywordsToPersons (default: true)
|
||||||
Client-Faces-writeAccessMinRole (default: 'Admin')
|
Client-Faces-writeAccessMinRole (default: 'Admin')
|
||||||
Client-Faces-readAccessMinRole (default: 'User')
|
Client-Faces-readAccessMinRole (default: 'User')
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### `config.json` sample:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"Server": {
|
||||||
|
"sessionSecret": [],
|
||||||
|
"port": 80,
|
||||||
|
"host": "0.0.0.0",
|
||||||
|
"Media": {
|
||||||
|
"//[folder]": "Images are loaded from this folder (read permission required)",
|
||||||
|
"folder": "demo/images",
|
||||||
|
"//[tempFolder]": "Thumbnails, converted photos, videos will be stored here (write permission required)",
|
||||||
|
"tempFolder": "demo/tmp",
|
||||||
|
"Video": {
|
||||||
|
"transcoding": {
|
||||||
|
"bitRate": 5242880,
|
||||||
|
"resolution": 720,
|
||||||
|
"fps": 25,
|
||||||
|
"codec": "libx264",
|
||||||
|
"format": "mp4",
|
||||||
|
"//[crf]": "Constant Rate Factor. The range of the CRF scale is 0–51, where 0 is lossless, 23 is the default, and 51 is worst quality possible.",
|
||||||
|
"crf": 23,
|
||||||
|
"//[preset]": "A preset is a collection of options that will provide a certain encoding speed to compression ratio",
|
||||||
|
"preset": "medium",
|
||||||
|
"//[customOptions]": "It will be sent to ffmpeg as it is, as custom options.",
|
||||||
|
"customOptions": []
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Photo": {
|
||||||
|
"Converting": {
|
||||||
|
"//[onTheFly]": "Converts photos on the fly, when they are requested.",
|
||||||
|
"onTheFly": true,
|
||||||
|
"resolution": 1080
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Thumbnail": {
|
||||||
|
"//[qualityPriority]": "if true, photos will have better quality.",
|
||||||
|
"qualityPriority": true,
|
||||||
|
"personFaceMargin": 0.6
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Preview": {
|
||||||
|
"SearchQuery": {
|
||||||
|
"type": 100,
|
||||||
|
"text": ""
|
||||||
|
},
|
||||||
|
"Sorting": [
|
||||||
|
6,
|
||||||
|
4
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Threading": {
|
||||||
|
"//[enabled]": "App can run on multiple thread",
|
||||||
|
"enabled": true,
|
||||||
|
"//[thumbnailThreads]": "Number of threads that are used to generate thumbnails. If 0, number of 'CPU cores -1' threads will be used.",
|
||||||
|
"thumbnailThreads": 0
|
||||||
|
},
|
||||||
|
"Database": {
|
||||||
|
"type": "sqlite",
|
||||||
|
"dbFolder": "db",
|
||||||
|
"sqlite": {
|
||||||
|
"DBFileName": "sqlite.db"
|
||||||
|
},
|
||||||
|
"mysql": {
|
||||||
|
"host": "localhost",
|
||||||
|
"port": 3306,
|
||||||
|
"database": "pigallery2",
|
||||||
|
"username": "",
|
||||||
|
"password": ""
|
||||||
|
},
|
||||||
|
"//[enforcedUsers]": "Creates these users in the DB if they do not exist. If a user with this name exist, it wont be overwritten, even if the role is different.",
|
||||||
|
"enforcedUsers": []
|
||||||
|
},
|
||||||
|
"Sharing": {
|
||||||
|
"updateTimeout": 300000
|
||||||
|
},
|
||||||
|
"//[sessionTimeout]": "unit: ms",
|
||||||
|
"sessionTimeout": 604800000,
|
||||||
|
"Indexing": {
|
||||||
|
"cachedFolderTimeout": 3600000,
|
||||||
|
"reIndexingSensitivity": "low",
|
||||||
|
"//[excludeFolderList]": "If an entry starts with '/' it is treated as an absolute path. If it doesn't start with '/' but contains a '/', the path is relative to the image directory. If it doesn't contain a '/', any folder with this name will be excluded.",
|
||||||
|
"excludeFolderList": [
|
||||||
|
".Trash-1000",
|
||||||
|
".dtrash",
|
||||||
|
"$RECYCLE.BIN"
|
||||||
|
],
|
||||||
|
"//[excludeFileList]": "Any folder that contains a file with this name will be excluded from indexing.",
|
||||||
|
"excludeFileList": []
|
||||||
|
},
|
||||||
|
"//[photoMetadataSize]": "only this many bites will be loaded when scanning photo for metadata",
|
||||||
|
"photoMetadataSize": 524288,
|
||||||
|
"Duplicates": {
|
||||||
|
"listingLimit": 1000
|
||||||
|
},
|
||||||
|
"Log": {
|
||||||
|
"level": "info",
|
||||||
|
"sqlLevel": "error",
|
||||||
|
"logServerTiming": false
|
||||||
|
},
|
||||||
|
"Jobs": {
|
||||||
|
"//[maxSavedProgress]": "Job history size",
|
||||||
|
"maxSavedProgress": 10,
|
||||||
|
"scheduled": [
|
||||||
|
{
|
||||||
|
"name": "Indexing",
|
||||||
|
"jobName": "Indexing",
|
||||||
|
"config": {
|
||||||
|
"indexChangesOnly": true
|
||||||
|
},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "never"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Preview Filling",
|
||||||
|
"jobName": "Preview Filling",
|
||||||
|
"config": {},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "never"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Thumbnail Generation",
|
||||||
|
"jobName": "Thumbnail Generation",
|
||||||
|
"config": {
|
||||||
|
"sizes": [
|
||||||
|
240
|
||||||
|
],
|
||||||
|
"indexedOnly": true
|
||||||
|
},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "after",
|
||||||
|
"afterScheduleName": "Preview Filling"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Photo Converting",
|
||||||
|
"jobName": "Photo Converting",
|
||||||
|
"config": {
|
||||||
|
"indexedOnly": true
|
||||||
|
},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "after",
|
||||||
|
"afterScheduleName": "Thumbnail Generation"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Video Converting",
|
||||||
|
"jobName": "Video Converting",
|
||||||
|
"config": {
|
||||||
|
"indexedOnly": true
|
||||||
|
},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "after",
|
||||||
|
"afterScheduleName": "Photo Converting"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "Temp Folder Cleaning",
|
||||||
|
"jobName": "Temp Folder Cleaning",
|
||||||
|
"config": {
|
||||||
|
"indexedOnly": true
|
||||||
|
},
|
||||||
|
"allowParallelRun": false,
|
||||||
|
"trigger": {
|
||||||
|
"type": "after",
|
||||||
|
"afterScheduleName": "Video Converting"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Client": {
|
||||||
|
"applicationTitle": "PiGallery 2",
|
||||||
|
"publicUrl": "",
|
||||||
|
"urlBase": "",
|
||||||
|
"Search": {
|
||||||
|
"enabled": true,
|
||||||
|
"searchCacheTimeout": 3600000,
|
||||||
|
"AutoComplete": {
|
||||||
|
"enabled": true,
|
||||||
|
"targetItemsPerCategory": 5,
|
||||||
|
"maxItems": 30,
|
||||||
|
"cacheTimeout": 3600000
|
||||||
|
},
|
||||||
|
"maxMediaResult": 10000,
|
||||||
|
"//[listDirectories]": "Search returns also with directories, not just media",
|
||||||
|
"listDirectories": false,
|
||||||
|
"//[listMetafiles]": "Search also returns with metafiles from directories that contain a media file of the matched search result",
|
||||||
|
"listMetafiles": true,
|
||||||
|
"maxDirectoryResult": 200
|
||||||
|
},
|
||||||
|
"Sharing": {
|
||||||
|
"enabled": true,
|
||||||
|
"passwordProtected": true
|
||||||
|
},
|
||||||
|
"Album": {
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
|
"Map": {
|
||||||
|
"enabled": true,
|
||||||
|
"//[maxPreviewMarkers]": "Maximum number of markers to be shown on the map preview on the gallery page.",
|
||||||
|
"maxPreviewMarkers": 50,
|
||||||
|
"useImageMarkers": true,
|
||||||
|
"mapProvider": "OpenStreetMap",
|
||||||
|
"mapboxAccessToken": "",
|
||||||
|
"customLayers": [
|
||||||
|
{
|
||||||
|
"name": "street",
|
||||||
|
"url": ""
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"RandomPhoto": {
|
||||||
|
"//[enabled]": "Enables random link generation. NOTE: With the current implementation, it poses a security risk. See https://github.com/bpatrik/pigallery2/issues/392",
|
||||||
|
"enabled": false
|
||||||
|
},
|
||||||
|
"Other": {
|
||||||
|
"customHTMLHead": "",
|
||||||
|
"enableCache": true,
|
||||||
|
"enableOnScrollRendering": true,
|
||||||
|
"defaultPhotoSortingMethod": "ascDate",
|
||||||
|
"//[enableDirectorySortingByDate]": "If enabled directories will be sorted by date, like photos, otherwise by name. Directory date is the last modification time of that directory not the creation date of the oldest photo",
|
||||||
|
"enableDirectorySortingByDate": false,
|
||||||
|
"enableOnScrollThumbnailPrioritising": true,
|
||||||
|
"NavBar": {
|
||||||
|
"showItemCount": true
|
||||||
|
},
|
||||||
|
"captionFirstNaming": false,
|
||||||
|
"enableDownloadZip": false,
|
||||||
|
"//[enableDirectoryFlattening]": "Adds a button to flattens the file structure, by listing the content of all subdirectories.",
|
||||||
|
"enableDirectoryFlattening": false
|
||||||
|
},
|
||||||
|
"authenticationRequired": true,
|
||||||
|
"unAuthenticatedUserRole": "Admin",
|
||||||
|
"Media": {
|
||||||
|
"Thumbnail": {
|
||||||
|
"iconSize": 45,
|
||||||
|
"personThumbnailSize": 200,
|
||||||
|
"thumbnailSizes": [
|
||||||
|
240,
|
||||||
|
480
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"Video": {
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
|
"Photo": {
|
||||||
|
"Converting": {
|
||||||
|
"enabled": true
|
||||||
|
},
|
||||||
|
"//[loadFullImageOnZoom]": "Enables loading the full resolution image on zoom in the ligthbox (preview).",
|
||||||
|
"loadFullImageOnZoom": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"MetaFile": {
|
||||||
|
"//[gpx]": "Reads *.gpx files and renders them on the map.",
|
||||||
|
"gpx": true,
|
||||||
|
"//[markdown]": "Reads *.md files in a directory and shows the next to the map.",
|
||||||
|
"markdown": true,
|
||||||
|
"//[pg2conf]": "Reads *.pg2conf files (You can use it for custom sorting and save search (albums)).",
|
||||||
|
"pg2conf": true
|
||||||
|
},
|
||||||
|
"Faces": {
|
||||||
|
"enabled": true,
|
||||||
|
"keywordsToPersons": true,
|
||||||
|
"writeAccessMinRole": "Admin",
|
||||||
|
"readAccessMinRole": "User"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}```
|
Loading…
Reference in New Issue
Block a user