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 pageGeneric BundleNext pageAzure

    #Source code

    If you like to fix and tweak HomeGallery you can checkout the source code, install the npm dependencies and build the packages.

    #Quickstart

    git clone https://github.com/xemle/home-gallery.git
    cd home-gallery
    npm install --force
    npm run build
    ./gallery.js run init --source ~/Pictures
    ./gallery.js run server

    #Run the CLI

    The CLI with all commands from source is started via

    ./gallery.js -h

    #Upgrade the gallery

    To upgrade the gallery software, please stop your current server, fetch the latest master, build the sources 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
    # Got to the source directory
    git pull
    npm i
    npm run clean
    npm run build
    ./gallery.js run import
    ./gallery.js run server