Recipes

Use Nginx proxy with subpath

Demonstrate how to use HomeGallery with docker compose and http proxy nginx with base path /pictures

File nginx.conf:

server {
    location / {
        root /var/www/html;
    }

    location = /pictures {
        rewrite ^ /pictures/;
    }

    location /pictures/ {
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;

        proxy_pass http://gallery:3000/pictures/;
    }
}

File compose.yml:

services:
  gallery:
    image: xemle/home-gallery
    environment:
      #- GALLERY_API_SERVER=http://api:3000
      - GALLERY_API_SERVER_CONCURRENT=1 # for SoC devices like Rasperry Pi. Use 5 otherwise
      - GALLERY_API_SERVER_TIMEOUT=60 # for SoC devices like Rasperry Pi. Use 30 otherwise
      #- GALLERY_USE_NATIVE=ffprobe,ffmpeg,vipsthumbnail # On issues with sharp resizer
      - GALLERY_OPEN_BROWSER=false
      # Use polling for safety of possible network mounts. Try 0 to use inotify via fs.watch
      - GALLERY_WATCH_POLL_INTERVAL=300
      # Define server prefix
      - GALLERY_PREFIX=/pictures
    volumes:
      - ./data:/data
      # Mount your media directories below /data
      - ${HOME}/Pictures:/data/Pictures
    user: "${CURRENT_USER}"
    entrypoint: ['node', '/app/gallery.js']
    command: ['run', 'server']

  nginx:
    image: nginx:1-alpine
    ports:
      - 8080:80
    volumes:
      - ./nginx.conf:/etc/nginx/conf.d/default.conf

Start

mkdir -p data/config
echo "CURRENT_USER=$(id -u):$(id -g)" >> .env
docker compose run gallery run init --source /data/Pictures
docker compose up -d

Open localhost:8080/pictures in your browser

Use Traefik proxy with subpath

Demonstrate how to use HomeGallery with docker compose and http proxy traefik with base path /pictures

File config.conf:

http:
  routers:
    gallery:
      rule: "PathPrefix(`/pictures`)"
      service: gallery
  services:
    gallery:
      loadBalancer:
        servers:
          - url: "http://gallery:3000"

File compose.yml:

services:
  gallery:
    image: xemle/home-gallery
    environment:
      #- GALLERY_API_SERVER=http://api:3000
      - GALLERY_API_SERVER_CONCURRENT=1 # for SoC devices like Rasperry Pi. Use 5 otherwise
      - GALLERY_API_SERVER_TIMEOUT=60 # for SoC devices like Rasperry Pi. Use 30 otherwise
      #- GALLERY_USE_NATIVE=ffprobe,ffmpeg,vipsthumbnail # On issues with sharp resizer
      - GALLERY_OPEN_BROWSER=false
      # Use polling for safety of possible network mounts. Try 0 to use inotify via fs.watch
      - GALLERY_WATCH_POLL_INTERVAL=300
      # Define server prefix
      - GALLERY_PREFIX=/pictures
    volumes:
      - ./data:/data
      # Mount your media directories below /data
      - ${HOME}/Pictures:/data/Pictures
    user: "${CURRENT_USER}"
    entrypoint: ['node', '/app/gallery.js']
    command: ['run', 'server']

  traefik:
    image: traefik
    command:
      - "--entryPoints.web.address=:8080"
      - "--providers.file.filename=/etc/config.yml"
    ports:
      - "8080:8080"
    volumes:
      - ./config.yml:/etc/config.yml

Start

mkdir -p data/config
echo "CURRENT_USER=$(id -u):$(id -g)" >> .env
docker compose run gallery run init --source /data/Pictures
docker compose up -d

Open localhost:8080/pictures in your browser

Use IIS Proxy With a Sub-Path

Demonstrate how to use HomeGallery with IIS used as a proxy with base path /pictures

Install URL Rewrite Module (if not already installed)

• Download and install Web Platform Installer from here Web Platform Installer : The Official Microsoft IIS Site

• Run Microsoft Web Platform Installer from the Start Menu.

• Search for “url rewrite”.

• Locate URL Rewrite 2.1 and click Add:

• Search for “application request routing”

• Locate Application Request Routing 3.0 and click Add.

• Click Install and “I Accept” to install the add in’s

• Click Finish.

Enable ARR

• In IIS Manager click on your server. Double-click Application Request Routing Cache:

• Click Server Proxy Settings in the Action pane.

• Check the Enable Proxy box.

• Click Apply in the Action Pane.

Setup Website (if it doesn’t already exist)

Setup your root website in IIS Manager as normal with binding, e.g. www.mysite.com

This is the site you want to put your photos in a sub-path below.

Setup Url Rewrite for Proxy

With the new website selected double double-click URL Rewrite:

• Click Add Rule(s)… in the Action pane.

• Select to create a Blank Inbound Rule.

• Configure the rule as shown below:

• Click Apply.

Configure Home Gallery

Configure the prefix in the server section of gallery.config.yml as follows:

server:
    prefix: /pictures

Start (or restart) Home Gallery.

Test the Site

• Test the local site by opening http://localhost:3000/pictures in your browser.

• Test the remote site by opening http://www.mysite.com/gallery in your browser.

web.config File

The web.config file is shown below for reference:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <system.webServer>
    <rewrite>
      <rules>
        <rule name="HomeGalleryProxy" stopProcessing="true">
          <match url="^pictures(.*)" />
          <action type="Rewrite"
            url="http://localhost:3000/pictures/{R:1}" />
        </rule>
      </rules>
    </rewrite>
    <urlCompression doStaticCompression="true" />
  </system.webServer>
</configuration>