Gallery
Gallery Overrides
All settings in the table below can have a gallery specific override by appending the gallery name to the end of the key. For example if the environment variable REQUIRE_REVIEW_PROPOSAL is specified it will override the value specified using the REQUIRE_REVIEW environment variable.
| Name | Value |
|---|---|
| TITLE | Changes the title displayed in the header and tabs. Default: "WeddingShare" |
| LOGO | Changes the icon displayed in the header and tabs. To change please provide the full Url to an image resouce or the path to a file if using volume mappings. Default: "/images/logo.png" |
| GALLERY_BANNER_IMAGE | If set a banner image will be displayed at the top of the gallery. Default: none |
| GALLERY_QUOTE | If set a quote message will display at the top of the gallery. Default: none |
| GALLERY_SECRET_KEY | This is the secret key used to authenticate to the gallery page. Default: none |
| GALLERY_COLUMNS | The number of columns to display horizontally on larger displays. The options are based on Bootstrap so you can choose between 1, 2, 3, 4, 6 or 12.Default: 4 |
| GALLERY_ITEMS_PER_PAGE | This sets the number of items to show per page. Increasing this will show more content but impact page load and performance. Default: 50 |
| GALLERY_FULL_WIDTH | If enabled the gallery options will be hidden on larger displays so the content spans the full width of the page. Default: false |
| GALLERY_RETAIN_REJECTED_ITEMS | If enabled rejected items will be removed from the admin panel but still stored on disk in a rejected folder. Default: false |
| GALLERY_UPLOAD | If disabled the upload feature will not display for non-admin users. It will always display for admin users when logged in. Default: false |
| GALLERY_DOWNLOAD | If disabled the download button will not display for non-admin users. It will always display for admin users when logged in. Default: false |
| GALLERY_REQUIRE_REVIEW | If enabled all uploads will require approval from an admin before they display on site for users. This is a protection to prevent spam or NSFW items showing on site. Default: true |
| GALLERY_REVIEW_COUNTER | If disabled the total/approved/pending counter won't appear at the top of the gallery page. Default: true |
| GALLERY_PREVENT_DUPLICATES | If enabled the item hash will be stored in the database and compared against future uploads. If an upload hash matches an existing item it will be rejected. Default: true |
| GALLERY_QR_CODE_ENABLED | If disabled the QR code will be hidden from the gallery page. Default: true |
| GALLERY_QR_CODE_DEFAULT_VIEW | If set this will override the default view users will be brought to once scanned. The options are default, presentation or slideshow.Default: none |
| GALLERY_QR_CODE_DEFAULT_SORT | If set this will override the default order items will be sorted with once scanned. Default: none |
| GALLERY_IDLE_REFRESH_MINS | To keep the gallery page fresh on displays the page periodically refreshes if no activity is detected after X amount of minutes. This is great for wall mounted displays. Set a value of 0 to disable refreshing.Default: 5 |
| GALLERY_MAX_SIZE_MB | This is the size in Mb each gallery should be limited to. If the limit is reached users will no longer be allowed to upload content. Default: 1024 |
| GALLERY_MAX_FILE_SIZE_MB | This is the maximum allows file size in Mb for a single upload item. This is used to prevent massive high resolution uploads which would use up disk space and slow performance. Default: 10 |
| GALLERY_DEFAULT_VIEW | This is the default display mode to show users. The options are 0 (Default), 1 (Presentation) or 2 (Slideshow)Default: 0 |
| GALLERY_UPLOAD_PERIOD | This allows you to set specific upload windows. When outside these windows the upload feature will be hidden for non-admin users. Once the period starts the upload feature will be displayed to all users. The upload feature will always be visible to logged in admin users. Example: "2025-01-29 23:59" or "2025-01-01 00:00 / 2025-01-03 23:59" or "2025-01-01 00:00 / 2025-01-01 23:59, 2025-01-03 00:00 / 2025-01-03 23:59" Default: none |
| GALLERY_ALLOWED_FILE_TYPES | This sets the types of items that are allowed to be uploaded by users. Please note not all content types are advised or supported. An example is Apples heic format which is not accepted by non-Apple devices due to its licensing. You may add it here but it will display broken images and a bad user experience for non-Apple users. Default: ".jpg,.jpeg,.png,.mp4,.mov" |
Media Formats
Not all image formats are supported in browsers so although you may be able to add them via the ALLOWED_FILE_TYPES environment variable they may not be supported. One such format is Apples .heic format. It is specific to Apple devices and due to its licensing, a lot of browsers have not implemented it.
Custom Image Resources
For any environment variable that accepts an image resource you have 2 options:
Option 1 - (Web Resource)
You can use a Url making sure to only use Urls that link directly to external resources.
The Url must adhere to the following rules:
- Hosted externally and publicly accessible.
- Not originate from the WeddingShare container. (It won't be available at boot time when the container tries to pull it locally)
- Contain a file extension. E.g., https://some.domain.com/some_random_path/my_image.png
Option 2 - (Local Resource)
You can use locally stored resources using volume mappings.
First add an additional mapping:
- /var/lib/docker/volumes/WeddingShare-CustomResources/_data:/app/wwwroot/custom_resources
Then link directly to the image:
GALLERY_BANNER_IMAGE="/custom_resources/my_image.png"