Configure rgallery

Flags and environment variables

NAME:
   rgallery - A photo and video application.

USAGE:
   rgallery [global options] command [command options]

DESCRIPTION:
   The timeline for your photo and video library.

COMMANDS:
   scan     Scan the media directory for new, modified, or delete media items.
   users    Options for user tasks
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --dev                     Load assets from directory instead of embedding, allowing you to edit assets without a recompile. Disables caching of HTML and JSON responses. (default: false)
   --disable-auth            Load rgallery without a login. (default: false)
   --media value             Location of the media directory. (default: "./media")
   --data value              Location of the database directory (default: "./data")
   --cache value             Location of the cache directory for storing image thumbnails and video transcode files. (default: "./cache")
   --config value            Location of the config yaml file. Only needed if using lens aliases. (default: "./config/config.yml")
   --quality value           Thumbnail resize quality. (default: 60)
   --pregenerate-thumbs      Generate thumbnails and video transcode files during scan. Caution - may cause high server load if set to false. (default: true)
   --resize_service value    URL for resize service. [$RGALLERY_RESIZE_SERVICE]
   --location_service value  URL for reverse geocode service. [$RGALLERY_LOCATION_SERVICE]
   --location_dataset value  Dataset for reverse geocode lookup. Ex: Countries10, Countries110, Provinces10. Countries10 uses the least amount of memory, and Provinces10 the most. (default: "Provinces10")
   --tile_server value       URL for GeoServer tiles in XYZ format, ex https://tile.thunderforest.com/cycle/{z}/{x}/{y}.png?apikey=your-api-key-here. (default: "/tiles/{z}/{x}/{y}.png") [$RGALLERY_TILE_SERVER]
   --session_length value    Length of authenticated sessions in days. (default: 30) [$RGALLERY_SESSION_LENGTH]
   --include-originals       Include original images in web view. Setting this to true may cause slower image loading performance. (default: false)
   --on-this-day             Show media items that occurred on the current day in previous years. (default: true)
   --help, -h                show help

Configuration file

The configuration file is a YAML file that should be located at ./config/config.yml.

To use a different location, use the --config flag to specify the file location.

Configuration file example

Note: Only lens aliases are currently supported in the configuration file. Global options must use command line flags or, in some cases, environment variables.

aliases:
  lenses: # exif:alias
    '17-35mm f/2.8-4E': Tamron 17-35mm f/2.8-4 Di OSD
    'Tamron 17-35mm f/2.8-4 Di OSD (A037)': Tamron 17-35mm f/2.8-4 Di OSD
    'Tamron 17-35mm f/2.8-4 Di OSD': Tamron 17-35mm f/2.8-4 Di OSD
    'Nikon 105mm f/2.5 Ai-s': 'Nikon Ai-s 105mm f/2.5'
    'Nikon 105mm f/2.5 AI-s': 'Nikon Ai-s 105mm f/2.5'
    'Nikon AI-s 105mm f/2.5': 'Nikon Ai-s 105mm f/2.5'
    'Nikon AI-s 105mm f/2.5   ': 'Nikon Ai-s 105mm f/2.5'
    'Nikon 105mm f/2.5 Ai-s ': 'Nikon Ai-s 105mm f/2.5'
    'VR 70-200mm f/2.8G': 'AF-S Nikkor 70-200mm f/2.8G ED VR II'
    'AF-S Nikkor 70-200mm f/2.8G ED VR II': 'AF-S Nikkor 70-200mm f/2.8G ED VR II'