{ "Server": { "applicationTitle": "Trystan's Photos", "//[publicUrl]": "If you access the page from local network it's good to know the public url for creating sharing link.", "publicUrl": "", "//[urlBase]": "If you access the gallery under a sub url (like: https://mydomain.com/myGallery), set it here. If it is not working you might miss the '/' from the beginning of the url.", "urlBase": "", "//[apiPath]": "PiGallery api path.", "apiPath": "/pgapi", "//[customHTMLHead]": "Injects the content of this between the HTML tags of the app. (You can use it to add analytics or custom code to the app).", "customHTMLHead": "", "//[svgIcon]": "Sets the icon of the app. Rendered icons are cached in the tmp folder.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 512 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" }, "//[reloadClientOnServerUpdate]": "If set the UI will auto reload when client related config changed or the app was restarted (except when the UI shows the settings page).", "reloadClientOnServerUpdate": true, "sessionSecret": [ "98d4ef85e070d9d87854dfd07d12ab9e3719fa3190527a2b0e8c293c2a1c7a561f8f12348e5c39831c272b38f4b1678d31ece073a8bdea57852d889e0175f21b3b202de61fee5c0caa56f6e9b9d35114b3981e88b9b15f0cf79ddd4cf888f90d09c7dea977afcac7fc7982c47d9231fc5fbcb9285e56f4d7feba1e998c2ae884a20d5647807aaf9df32ac2ed5850dc81c63768052d99d3a7013798cc6abff21509c95a85e68630140fff2f478f2441b8fbc0a98cbece3f440153f50dc57e1e13556be65cbfb7cad90064581c1274de043f6d1668ccd4b37b6d7ac26ca7fc693904292394df206f4db873b9e10d521fa0e755ade92361a65edb1492b9df78c243", "245cea2ef89b8a2e1bdba26ea8768c3b782e94a95ec08862bbe5d4eab250c9457870020be63a83da5fc0820c57ba03b6261e07f033ce92a57ee1908a222e023a8ee71441e9a2a2643adc852543a3554d7e5fc85db234d0464a11546d04a0cb912d7ef7ef69d96f76546812fd77fdac0e269363b5a5ec6ef6a17d161583128c114157e3eb28c2cd8ad69ee0c1bbe0e4388361641497a3fec6797290c2f57b5bfda7edad049e33ca77c7db77e6fd3b65f6895bb6cae8c48e8eba4d221e8f495fcd145f393bbcc411e15918edacc0eb23358367be25e572bf8ef42e276c946c2974ee39118fa96bf3b8f7890900da595ef6292b5e71d7f62502f031275464c0cf17", "80355df396a5973f7bec2ab2a960895492c2f77cfe37e82ddc386b86c0294f7a637f3cf3c95a0ce454193397a36dc5fa40bd6a536007bfa2f3a9320dfda7c1843e498e6dfe80cbda1197db5908d854c21f7dac8fee36a88cf1a867fa69ea3efe2d7c209fd85517d366a89422d0c81c1e6ea147a3f3b873f9cb0e52ff09fbd7cf9f80cd8e052e10f0431c5610faf1e0ebd8c7f2d2164baa6ccb0bdb76741a861a0541dac2a63d4d43d81585c9393a296f6744d2b1be3586feda8e339e882a74dc1d2783c6dc122f7e777ebb5819e1069577d2aef5e74638b79ab71590c8e570c86a7252248a02917fa9dad4e02e8f335ccf7de1e955e35687d34222135b5f3fef" ], "//[sessionTimeout]": "Users kept logged in for this long time.", "sessionTimeout": 604800000, "//[trustProxy]": "Should the backend trust proxies to extract remote Client IP. See express docs, for valid values: https://expressjs.com/en/guide/behind-proxies.html", "trustProxy": "false", "//[port]": "Port number. Port 80 is usually what you need.", "port": 80, "//[host]": "Server will accept connections from this IPv6 or IPv4 address.", "host": "0.0.0.0", "Log": { "//[level]": "Logging level.", "level": "info", "//[sqlLevel]": "Logging level for SQL queries.", "sqlLevel": "error", "//[logServerTiming]": "If enabled, the app adds \"Server-Timing\" http header to the response.", "logServerTiming": false } }, "Users": { "//[authenticationRequired]": "Enables user management with login to password protect the gallery.", "authenticationRequired": true, "//[unAuthenticatedUserRole]": "Default user right when password protection is disabled.", "unAuthenticatedUserRole": "Admin", "//[oidc]": "Setup SSO with external authentication apps like Authentik or Authelia", "oidc": { "enabled": false, "//[displayName]": "Shown on the login button (client-visible).", "displayName": "", "//[issuerUrl]": "OIDC provider Issuer URL", "issuerUrl": "", "clientId": "", "clientSecret": "", "//[redirectUri]": "Full callback URL registered at the provider (e.g.: https://example.com/pgapi/auth/oidc/callback)", "redirectUri": "", "scopes": [ "openid", "profile", "email" ], "//[usernameClaim]": "JWT claim to use for matching user name. Defaults to preferred_username; fallbacks to email if empty.", "usernameClaim": "preferred_username", "emailClaim": "email", "//[allowedDomains]": "If set, only identities with emails in these domains will be accepted.", "allowedDomains": [], "//[autoCreateUser]": "If enabled, unknown users will be created with Guest role on first login. If disabled, only existing app users can log in.", "autoCreateUser": false }, "//[enforcedUsers]": "Creates these users in the DB during startup if they do not exist. If a user with this name exist, it won't be overwritten, even if the role is different.", "enforcedUsers": [], "//[allowQuery]": "Setting a non empty search query here will make the app to only SHOW photos and videos that match the query. You can override this at every user separately.", "allowQuery": { "type": 100, "value": "" }, "//[blockQuery]": "Setting a non empty search query here will make the app to HIDE photos and videos that match the query. You can override this at every user separately.", "blockQuery": { "type": 100, "value": "" }, "//[suppressDefUserWarn]": "if true, the app won't show a warning for using the default user.", "suppressDefUserWarn": false }, "Gallery": { "//[enableCache]": "Caches directory contents and search results for better performance.", "enableCache": true, "//[enableOnScrollRendering]": "Those thumbnails get higher priority that are visible on the screen.", "enableOnScrollRendering": true, "//[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, "//[ignoreTimestampOffset]": "If enabled, timestamp offsets are ignored, meaning that the local times of pictures are used for searching, sorting and grouping. If disabled, global time is used and pictures with no timestamp are assumed to be in UTC (offset +00:00).", "ignoreTimestampOffset": true, "//[enableOnScrollThumbnailPrioritising]": "Those thumbnails will be rendered first that are in view.", "enableOnScrollThumbnailPrioritising": true, "NavBar": { "//[enableDownloadZip]": "Enable zipped download of the listed directory or search results.", "enableDownloadZip": true, "//[enableDirectoryFlattening]": "Adds a button to flatten the file structure, by listing the content of all subdirectories. (Won't work if the gallery has multiple folders with the same path.)", "enableDirectoryFlattening": false, "//[defaultGidSize]": "Default grid size that is used to render photos and videos.", "defaultGidSize": "medium", "//[showItemCount]": "Shows the number photos and videos on the navigation bar.", "showItemCount": true, "//[links]": "Visible links in the top menu.", "links": [ { "type": "gallery" }, { "type": "albums" }, { "type": "faces" } ], "//[NavbarShowDelay]": "Ratio of the page height, you need to scroll to show the navigation bar.", "NavbarShowDelay": 0.3, "//[NavbarHideDelay]": "Ratio of the page height, you need to scroll to hide the navigation bar.", "NavbarHideDelay": 0.15, "//[showScrollUpButton]": "Set when the floating scroll-up button should be visible.", "showScrollUpButton": "mobileOnly", "SortingGrouping": { "//[defaultPhotoSortingMethod]": "Default sorting method for photo and video in a directory results.", "defaultPhotoSortingMethod": { "method": "Date", "ascending": true }, "//[defaultSearchSortingMethod]": "Default sorting method for photo and video in a search results.", "defaultSearchSortingMethod": { "method": "Date", "ascending": false }, "//[defaultPhotoGroupingMethod]": "Default grouping method for photo and video in a directory results.", "defaultPhotoGroupingMethod": { "method": "Date", "ascending": true }, "//[defaultSearchGroupingMethod]": "Default grouping method for photo and video in a search results.", "defaultSearchGroupingMethod": { "method": "Date", "ascending": false } } }, "//[captionFirstNaming]": "Show the caption (IPTC 120) tags from the EXIF data instead of the filenames.", "captionFirstNaming": false, "//[Lightbox]": "Photo and video preview window.", "Lightbox": { "//[slideshowSpeed]": "Default time interval for displaying a photo in the slide show.", "slideshowSpeed": 5, "//[captionAlwaysOn]": "If enabled, lightbox will always show caption by default, not only on hover.", "captionAlwaysOn": false, "//[facesAlwaysOn]": "If enabled, lightbox will always show faces by default, not only on hover.", "facesAlwaysOn": false, "//[loopVideos]": "If enabled, lightbox will loop videos by default.", "loopVideos": false, "//[loopSlideshow]": "If enabled, lightbox will start from the first photo when it reached the last one.", "loopSlideshow": false, "//[loadFullImageOnZoom]": "Enables loading the full resolution image on zoom in the lightbox (preview).", "loadFullImageOnZoom": true, "//[loadFullImageIfPreviewTooSmall]": "When enabled, the lightbox will load the full resolution image if all available preview thumbnails are too small for the current view.", "loadFullImageIfPreviewTooSmall": true, "//[Titles]": "Set these to customize the text (caption, location, etc.) in the lightbox that are always visible over the photo (not in the info panel).", "Titles": { "topLeftTitle": [ 6 ], "topLeftSubtitle": [ 5 ], "bottomLeftTitle": [ 10, 9 ], "bottomLeftSubtitle": [ 8 ] } }, "//[Themes]": "Pigallery2 uses Bootstrap 5.3 (https://getbootstrap.com/docs/5.3) for design (css, layout). In dark mode it sets 'data-bs-theme=\"dark\"' to the to take advantage bootstrap's color modes. For theming, read more at: https://getbootstrap.com/docs/5.3/customize/color-modes/", "Themes": { "//[enabled]": "Enable themes and color modes.", "enabled": true, "//[defaultMode]": "Sets the default theme mode that is used for the application.", "defaultMode": "auto", "//[selectedTheme]": "Selected theme to use on the site.", "selectedTheme": "classic", "//[availableThemes]": "Adds these CSS settings as it is to the end of the body tag of the page.", "availableThemes": [ { "//[name]": "Name of the theme", "name": "classic", "//[theme]": "Adds these css settings as it is to the end of the body tag of the page.", "theme": ":root nav.navbar {\n--bs-navbar-color: rgba(255, 255, 255, 0.55);\n--bs-navbar-hover-color: rgba(255, 255, 255, 0.75);\n--bs-navbar-disabled-color: rgba(255, 255, 255, 0.25);\n--bs-navbar-active-color: #fff;\n--bs-navbar-brand-color: #fff;\n--bs-navbar-brand-hover-color: #fff;\n--bs-bg-opacity: 1;\nbackground-color: rgba(var(--bs-dark-rgb), var(--bs-bg-opacity)) !important;\n}" } ] }, "//[InlineBlogStartsOpen]": "Makes inline blog (*.md files content) auto-open.", "InlineBlogStartsOpen": false, "//[TopBlogStartsOpen]": "Makes top blog (*.md files content) auto-open.", "TopBlogStartsOpen": false, "//[AutoUpdate]": "makes the gallery poll the backend for new photos in the given directory or search", "AutoUpdate": { "//[enable]": "Enable auto polling for new photos and videos in the gallery.", "enable": false, "//[interval]": "Frequency of the auto polling in seconds.", "interval": 60 } }, "Media": { "//[Video]": "Video support uses ffmpeg. ffmpeg and ffprobe binaries need to be available in the PATH or the @ffmpeg-installer/ffmpeg and @ffprobe-installer/ffprobe optional node packages need to be installed.", "Video": { "enabled": true, "//[supportedFormatsWithTranscoding]": "Video formats that are supported after transcoding (with the built-in ffmpeg support).", "supportedFormatsWithTranscoding": [ "avi", "mkv", "mov", "wmv", "flv", "mts", "m2ts", "mpg", "3gp", "m4v", "mpeg", "vob", "divx", "xvid", "ts" ], "//[supportedFormats]": "Video formats that are supported also without transcoding. Browser supported formats: https://www.w3schools.com/html/html5_video.asp", "supportedFormats": [ "mp4", "webm", "ogv", "ogg" ], "//[transcoding]": "To ensure smooth video playback, video transcoding is recommended to a lower bit rate than the server's upload rate. The transcoded videos will be saved to the thumbnail folder. You can trigger the transcoding manually, but you can also create an automatic encoding job in advanced settings mode.", "transcoding": { "//[bitRate]": "Target bit rate of the output video will be scaled down to this. This should be less than the upload rate of your home server.", "bitRate": 5242880, "//[resolution]": "The height of the output video will be scaled down to this, while keeping the aspect ratio.", "resolution": 720, "//[fps]": "Target frame per second (fps) of the output video will be scaled down to this.", "fps": 25, "format": "mp4", "mp4Codec": "libx264", "webmCodec": "libvpx", "//[crf]": "The range of the Constant Rate Factor (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. A slower preset will provide better compression (compression is quality per filesize).", "preset": "medium", "//[customOutputOptions]": "It will be sent to ffmpeg as it is, as custom output options.", "customOutputOptions": [], "//[customInputOptions]": "It will be sent to ffmpeg as it is, as custom input options.", "customInputOptions": [] } }, "Photo": { "//[iconSize]": "Icon size (used on maps).", "iconSize": 45, "//[personThumbnailSize]": "Person (face) thumbnail size.", "personThumbnailSize": 200, "//[thumbnailSizes]": "Size of the thumbnails and photo previews. The best matching size will be used (smaller for photo and video thumbnail, bigger for photo preview). More sizes give better quality, but use more storage and CPU to render. If size is 240, that shorter side of the thumbnail will be 240 pixels.", "thumbnailSizes": [ 320, 540, 1080, 2160 ], "//[concurrentThumbnailGenerationsLimit]": "By default the app uses the number of cpus -1 concurrent threads to generate thumbnails. Set this number higher than 0 to limit the number of concurrent threads.", "concurrentThumbnailGenerationsLimit": 0, "//[supportedFormats]": "Photo formats that are supported. Browser needs to support these formats natively. Also sharp (libvips) package should be able to convert these formats.", "supportedFormats": [ "gif", "jpeg", "jpg", "jpe", "png", "webp", "svg", "avif", "heic", "dng", "arw", "tiff" ], "//[useLanczos3]": "if true, 'lanczos3' will used to scale photos, otherwise faster but lower quality 'nearest'.", "useLanczos3": true, "//[quality]": "Between 0-100.", "quality": 80, "//[smartSubsample]": "Use high quality chroma subsampling in webp. See: https://sharp.pixelplumbing.com/api-output#webp.", "smartSubsample": true, "//[sharpOptions]": "Add any sharp options here. They will be added to sharp constructor as raw params. See: https://sharp.pixelplumbing.com/api-constructor/.", "sharpOptions": { "test": 444 }, "//[personFaceMargin]": "This ratio of the face bounding box will be added to the face as a margin. Higher number add more margin.", "personFaceMargin": 0.7, "//[animateGif]": "Converts Gif to animated webp.", "animateGif": true }, "//[folder]": "Images are loaded from this folder (read permission required)", "folder": "/app/data/images", "//[tempFolder]": "Thumbnails, converted photos, videos will be stored here (write permission required)", "tempFolder": "/app/data/tmp" }, "MetaFile": { "//[gpx]": "Reads *.gpx files and renders them on the map.", "gpx": true, "GPXCompressing": { "//[enabled]": "Enables lossy (based on delta time and distance. Too frequent points are removed) GPX compression.", "enabled": true, "//[onTheFly]": "Enables on the fly *.gpx compression.", "onTheFly": true, "//[minDistance]": "Filters out entry that are closer than this to each other in meters.", "minDistance": 5, "//[maxMiddleDeviance]": "Filters out entry that would fall on the line if we would just connect the previous and the next points. This setting sets the sensitivity for that (higher number, more points are filtered).", "maxMiddleDeviance": 5, "//[minTimeDistance]": "Filters out entry that are closer than this in time in milliseconds.", "minTimeDistance": 5000 }, "//[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 saved search (albums)).", "pg2conf": true, "//[supportedFormats]": "The app will read and process these files.", "supportedFormats": [ "gpx", "pg2conf", "md" ] }, "Album": { "enabled": true, "//[readAccessMinRole]": "Required minimum right to show the albums tab.", "readAccessMinRole": "User" }, "Search": { "//[enabled]": "Enables searching.", "enabled": true, "//[searchCacheTimeout]": "Search cache timeout.", "searchCacheTimeout": 3600000, "AutoComplete": { "//[enabled]": "Show hints while typing search query.", "enabled": true, "//[ItemsPerCategory]": "Maximum number autocomplete items shown per category.", "ItemsPerCategory": { "//[maxItems]": "Maximum number autocomplete items shown at once. If there is not enough items to reach this value, it takes up to double of the individual items.", "maxItems": 20, "//[fileName]": "Maximum number autocomplete items shown per photo category.", "fileName": 2, "//[directory]": "Maximum number autocomplete items shown per directory category.", "directory": 2, "//[caption]": "Maximum number autocomplete items shown per caption category.", "caption": 3, "//[position]": "Maximum number autocomplete items shown per position category.", "position": 3, "//[person]": "Maximum number autocomplete items shown per faces category.", "person": 5, "//[keyword]": "Maximum number autocomplete items shown per keyword category.", "keyword": 5 }, "//[cacheTimeout]": "Autocomplete cache timeout. ", "cacheTimeout": 3600000 }, "//[maxMediaResult]": "Maximum number of photos and videos that are listed in one search result.", "maxMediaResult": 10000, "//[maxDirectoryResult]": "Maximum number of directories that are listed in one search result.", "maxDirectoryResult": 200, "//[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 }, "Sharing": { "//[enabled]": "Enables sharing.", "enabled": true, "//[passwordRequired]": "Requires password protected sharing links.", "passwordRequired": false, "//[sharingKeyLength]": "The longer the keys are, the harder they are to guess. Changing this number won't invalidate existing sharing.", "sharingKeyLength": 8, "//[updateTimeout]": "After creating a sharing link, it can be updated for this long.", "updateTimeout": 300000 }, "Map": { "enabled": true, "//[useImageMarkers]": "Map will use thumbnail images as markers instead of the default pin.", "useImageMarkers": true, "mapProvider": "OpenStreetMap", "//[mapboxAccessToken]": "MapBox needs an access token to work, create one at https://www.mapbox.com.", "mapboxAccessToken": "", "//[customLayers]": "The map module will use these urls to fetch the map tiles.", "customLayers": [ { "//[name]": "Name of a map layer.", "name": "street", "//[url]": "Url of a map layer.", "url": "", "//[darkLayer]": "Sets if the layer is dark (used as default in the dark mode).", "darkLayer": false } ], "//[maxPreviewMarkers]": "Maximum number of markers to be shown on the map preview on the gallery page.", "maxPreviewMarkers": 50, "//[MapPathGroupConfig]": "Markers are grouped and themed by these settings", "MapPathGroupConfig": [ { "//[name]": "Name of the marker and path group on the map.", "name": "Transportation", "//[matchers]": "Matchers for a given map and path theme.", "matchers": [ { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "flight", "flying" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-orange)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "4 8", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 567 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "drive", "driving" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-orange)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "4 8", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 640 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "ship", "sailing", "cruise" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-orange)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "4 8", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 576 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } } ] }, { "//[name]": "Name of the marker and path group on the map.", "name": "Sport", "//[matchers]": "Matchers for a given map and path theme.", "matchers": [ { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "(\b|_|-)run" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-primary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 417 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "(\b|_|-)walk" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-primary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 320 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "(\b|_|-)hike", "(\b|_|-)hiking" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-primary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 384 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "(\b|_|-)bike", "(\b|_|-)biking", "(\b|_|-)cycling" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-primary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 640 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } }, { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [ "(\b|_|-)skiing", "(\b|_|-)ski" ], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-primary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "0 0 512 512", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } } ] }, { "//[name]": "Name of the marker and path group on the map.", "name": "Other paths", "//[matchers]": "Matchers for a given map and path theme.", "matchers": [ { "//[matchers]": "List of regex string to match the name of the path. Case insensitive. Empty list matches everything.", "matchers": [], "//[theme]": "List of regex string to match the name of the path.", "theme": { "//[color]": "Color of the path. Use any valid css colors.", "color": "var(--bs-secondary)", "//[dashArray]": "Dash pattern of the path. Represents the spacing and length of the dash. Read more about dash array at: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/stroke-dasharray.", "dashArray": "", "//[svgIcon]": "Set the icon of the map marker pin.", "svgIcon": { "//[viewBox]": "SVG path viewBox. See: https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/viewBox", "viewBox": "", "//[items]": "Content elements (paths, circles, rects) of the SVG icon. Icons used on the map: fontawesome.com/icons.", "items": "" } } } ] } ], "//[bendLongPathsTrigger]": "Map will bend the path if two points are this far apart on latitude axes. This intended to bend flight if only the end and the start points are given.", "bendLongPathsTrigger": 0.5 }, "Faces": { "enabled": true, "//[sorting]": "Default sorting on the faces page", "sorting": { "method": "PersonCount", "ascending": true }, "//[keywordsToPersons]": "If a photo has the same face (person) name and keyword, the app removes the duplicate, keeping the face only.", "keywordsToPersons": true, "//[writeAccessMinRole]": "Required minimum right to star (favourite) a face.", "writeAccessMinRole": "Admin", "//[readAccessMinRole]": "Required minimum right to show the faces tab.", "readAccessMinRole": "User" }, "//[RandomPhoto]": "This feature enables you to generate 'random photo' urls. That URL returns a photo random selected from your gallery. You can use the url with 3rd party application like random changing desktop background. Note: With the current implementation, random link also requires login.", "RandomPhoto": { "//[enabled]": "Enables random link generation.", "enabled": true }, "Extensions": { "enabled": true, "//[repositoryUrl]": "Repository url that points to a list of extensions in .md format.", "repositoryUrl": "https://raw.githubusercontent.com/bpatrik/pigallery2/master/extension/REPOSITORY.md", "//[folder]": "Folder where the app stores all extensions. Individual extensions live in their own sub-folders.", "folder": "/app/data/config/extensions", "extensions": {}, "//[cleanUpUnusedTables]": "Automatically removes all tables from the DB that are not used anymore.", "cleanUpUnusedTables": true }, "Upload": { "enabled": false, "//[minimumRole]": "Minimum user role to enable file upload.", "minimumRole": "Admin", "//[enforcedDirectoryConfig]": "Only enable upload in folder where an \".uploader.pg2conf\" is present in the folder.", "enforcedDirectoryConfig": false }, "Database": { "//[type]": "SQLite is recommended.", "type": "sqlite", "//[dbFolder]": "All file-based data will be stored here (sqlite database, job history data).", "dbFolder": "/app/data/db", "sqlite": { "//[DBFileName]": "Sqlite will save the db with this filename.", "DBFileName": "sqlite.db" }, "mysql": { "host": "localhost", "port": 3306, "database": "pigallery2", "username": "", "password": "" } }, "Indexing": { "//[cachedFolderTimeout]": "If there was no indexing in this time, it reindexes. (skipped if indexes are in DB and sensitivity is low).", "cachedFolderTimeout": 3600000, "//[reIndexingSensitivity]": "Set the reindexing sensitivity. High value check the folders for change more often. Setting to never only indexes if never indexed or explicit running the Indexing Job.", "reIndexingSensitivity": "low", "//[excludeFolderList]": "Folders to exclude from indexing. 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]": "Files that mark a folder to be excluded from indexing. Any folder that contains a file with this name will be excluded from indexing.", "excludeFileList": [] }, "//[AlbumCover]": "Specify a search query and sorting that the app can use to pick the best photo for an album and folder cover. There is no way to manually pick folder and album cover in the app. You can tag some of your photos with 'cover' and set that as search query or rate them to 5 and set sorting to descending by rating.", "AlbumCover": { "//[SearchQuery]": "Filters the sub-folders with this search query. If filter results no photo, the app will search again without the filter.", "SearchQuery": { "type": 100, "value": "" }, "//[Sorting]": "If multiple cover is available sorts them by these methods and selects the first one. Using random sorting does not allow to use any other sorting method.", "Sorting": [ { "method": "Rating", "ascending": false }, { "method": "Date", "ascending": false }, { "method": "PersonCount", "ascending": false } ] }, "Duplicates": { "//[listingLimit]": "Maximum number of duplicates to list.", "listingLimit": 1000 }, "//[Messaging]": "The App can send messages (like photos on the same day a year ago. aka: \"Top Pick\"). Here you can configure the delivery method.", "Messaging": { "//[Email]": "The app uses Nodemailer in the background for sending e-mails. Refer to https://nodemailer.com/usage/ if some options are not clear.", "Email": { "//[emailFrom]": "Some services do not allow sending from random e-mail addresses. Set this accordingly.", "emailFrom": "noreply@pigallery2.com", "smtp": { "//[host]": "SMTP host server", "host": "", "//[port]": "SMTP server's port", "port": 587, "//[secure]": "Is the connection secure. See https://nodemailer.com/smtp/#tls-options for more details", "secure": false, "//[requireTLS]": "if this is true and secure is false then Nodemailer (used library in the background) tries to use STARTTLS. See https://nodemailer.com/smtp/#tls-options for more details", "requireTLS": true, "//[user]": "User to connect to the SMTP server.", "user": "", "//[password]": "Password to connect to the SMTP server.", "password": "" } } }, "Jobs": { "//[maxSavedProgress]": "Job history size.", "maxSavedProgress": 20, "//[mediaProcessingBatchSize]": "Jobs load this many photos or videos from the DB for processing at once.", "mediaProcessingBatchSize": 1000, "scheduled": [ { "name": "Indexing", "jobName": "Indexing", "config": { "indexChangesOnly": true }, "allowParallelRun": false, "trigger": { "type": "never", "periodicity": 7, "atTime": 0 } }, { "name": "Album Cover Filling", "jobName": "Album Cover Filling", "config": {}, "allowParallelRun": false, "trigger": { "type": "after", "periodicity": 7, "atTime": 0, "afterScheduleName": "Indexing" } }, { "name": "Photo Converting", "jobName": "Photo Converting", "config": { "sizes": [ 320 ], "maxVideoSize": 800, "indexedOnly": true }, "allowParallelRun": false, "trigger": { "type": "after", "periodicity": 7, "atTime": 0, "afterScheduleName": "Album Cover Filling" } }, { "name": "Video Converting", "jobName": "Video Converting", "config": { "indexedOnly": true }, "allowParallelRun": false, "trigger": { "type": "after", "periodicity": 7, "atTime": 0, "afterScheduleName": "Photo Converting" } }, { "name": "GPX Compression", "jobName": "GPX Compression", "config": { "indexedOnly": true }, "allowParallelRun": false, "trigger": { "type": "after", "periodicity": 7, "atTime": 0, "afterScheduleName": "Video Converting" } }, { "name": "Temp Folder Cleaning", "jobName": "Temp Folder Cleaning", "config": { "indexedOnly": true }, "allowParallelRun": false, "trigger": { "type": "after", "periodicity": 7, "atTime": 0, "afterScheduleName": "GPX Compression" } } ] } }