Gallery #

Gallery shows the pictures in a folder as an album in a grid. Clicking a picture opens a slideshow with full screen and zoom. Albums can be shared through a public link. Recipients see them in the same view, without an account.

Requirements #

Installation #

Open Market from the app menu, search for Gallery, and click Install. On the command line:

# install the app from the Marketplace; this also enables it
sudo -u www-data php8.4 occ market:install gallery

# only needed if the app is present but disabled
sudo -u www-data php8.4 occ app:enable gallery

Setup #

The app has no settings page of its own. It follows server settings and a gallery.cnf file per album.

Server settings #

Which picture types Gallery shows depends on the server's preview providers:

If you set enabledPreviewProviders yourself, your list replaces the default completely. So include the providers you want to keep. This example keeps all default providers and adds TIFF, Photoshop, Illustrator, PostScript, and SVG:

'enabledPreviewProviders' => [
    'OC\\Preview\\MarkDown',
    'OC\\Preview\\MP3',
    'OC\\Preview\\TXT',
    'OC\\Preview\\PNG',
    'OC\\Preview\\JPEG',
    'OC\\Preview\\WEBP',
    'OC\\Preview\\GIF',
    'OC\\Preview\\BMP',
    'OC\\Preview\\Heic',
    'OC\\Preview\\XBitmap',
    'OC\\Preview\\SGI',
    'OC\\Preview\\TIFF',
    'OC\\Preview\\Photoshop',
    'OC\\Preview\\Illustrator',
    'OC\\Preview\\Postscript',
    'OC\\Preview\\SVG',
],

Album configuration gallery.cnf #

gallery.cnf is a YAML file in the album folder. Gallery reads it when the album opens. Sections with inherit: yes also apply to sub-albums. Gallery reads the features section only in the top folder.

features:
  native_svg: yes
  external_shares: yes
  background_colour_toggle: yes

sorting:
  type: date
  order: des
  inherit: yes

design:
  background: "#ffffff"
  inherit: yes

information:
  description: "Photos from the factory tour"
  description_link: readme.md
  copyright: "© Example Inc."
  copyright_link: copyright.md
  inherit: yes

Gallery ignores invalid values. If the file is not valid YAML, Gallery shows Configuration error, and the server log names the location.

Usage #

• Open: Gallery in the app menu. Every folder with pictures appears as an album. Use the path bar to reach sub-albums.
• Sort: Sort by name and Sort by date switch the field and the order.
• Switch: File list jumps to the same folder in the Files app, and Gallery view takes you back from there.
• Slideshow: Clicking a picture opens it with Next, Previous, Play, Pause, Download, and Close. Delete and rotating are available only outside public galleries and only if you may delete the file.
• Album information: appears if the album contains a gallery.cnf with a description or a copyright notice.
• Hide a folder: Hide Album in the + menu creates a .nomedia file in the folder. Gallery skips folders that contain this file.
• Share: Share at the top right opens the share dialog. A public link created there points to https://<instance>/index.php/apps/gallery/s/<token>. Set the password, expiration date, and uploads in the share dialog.

Gallery shows all pictures in a folder as an album. The share icon at the top right shares the album.

Limits and notes #

• Together with the Media Viewer: Gallery and the Media Viewer both register as the default action for pictures in the file list. Gallery usually wins. Users then reach the Media Viewer with … and Open in Media Viewer.
• Without a matching preview provider, an album stays empty, even if it contains pictures.
• Gallery does not include WebP and SGI pictures, even if the server creates previews for them. In the file list, the Media Viewer opens them if it is enabled.
• Pictures larger than 50 MB (preview_max_filesize_image) get no preview and show up in Gallery only as a gray tile.
• The token in a Gallery link is the same as in the normal link share. If you disable Gallery, Gallery links stop working. The same content stays available at https://<instance>/s/<token> in the normal file view.
• In shared folders, Gallery does not take over links (description_link, copyright_link) from a gallery.cnf that sits above the shared folder.

Troubleshooting #