logologo
HomeGallery
  • Why?
  • Docs
  • Demo
  • Download
    Start
    Install
    General
    docker-compose
    docker
    Binary
    App Bundle
    Generic Bundle
    Source
    Azure
    Configuration
    CLI
    help
    run
    export meta
    export static
    fetch
    database
    storage
    plugin
    cast
    Webapp
    Search
    FAQ
    API server
    Recipes
    Use Nginx proxy with subpath
    Use Traefik proxy with subpath
    Use IIS Proxy With a Sub-Path
    Internals
    Workflow
    Building Blocks
    Data Structures
    Design Decisions
    Development
    Plugin
    Extractor Plugin
    Database Mapper Plugin
    Query Plugin
    Previous pageApp BundleNext pageSource

    #Generic application bundle

    The generic archive of HomeGallery contains all JS resources without binary dependencies like node.js, sharp, ffmpeg or ffprobe.

    It requires following binaryies preinstalled on your system:

    • NodeJS LTS v24 (v22 should also work, older versions might work)
    • perl
    • ffmpeg
    • ffprobe
    • vipsthumbnail (via vips-tools) or convert (via ImageMagick)

    Further the extractor has to be configured to use these native commands. See configuration section for configuration details.

    #Quickstart

    curl -sL https://dl.home-gallery.org/dist/latest/home-gallery-latest-all-generic.tar.gz -o home-gallery.tar.gz
    tar xf home-gallery.tar.gz
    cd home-gallery
    ./gallery.js run init --source ~/Pictures
    # Edit gallery.config.yml and set native commands, see example below
    ./gallery.js run server &

    #Run the CLI

    The CLI with all commands of the generic bundle is started via

    ./gallery.js -h

    #Upgrade the gallery

    To upgrade the gallery software, please stop your current server, download the latest version and start the new version.

    Please run the import command to rebuild the database. This step will add new features and fix missing database entries. If all your media is already imported the import can be done in parallel with the server command.

    # stop the current server
    # downlaod and extract the newest generic bundle
    # change directory to home-gallery
    ./gallery.js run import
    ./gallery.js run server &

    Example configuration part for extractor:

    extractor:
      useNative:
        - vipsthumbnail
        - ffprobe
        - ffmpeg