Get Lumière

Lumière Server for Docker

For 64-bit Intel, AMD, and ARM machines

1. Change the two paths on the left of each : to your media folder and to a folder for the server's settings.
2. Run the command.
3. Open http://localhost:5059 in a browser.

docker run -d --name lumiere-server --restart unless-stopped \
  -p 5059:5058 \
  -v /path/to/media:/media \
  -v /path/to/config:/config \
  -v /var/run/docker.sock:/var/run/docker.sock \
  artsvit/lumiere-server:latest

services:
  lumiere-server:
    image: artsvit/lumiere-server:latest
    container_name: lumiere-server
    restart: unless-stopped
    ports:
      - "5059:5058"
    volumes:
      - /path/to/media:/media
      - /path/to/config:/config
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      - LUMIERE_CATEGORIES=Movies,TV Shows,Cartoon,Music

Install Lumière Server on this machine with Docker.

1. Check that Docker is installed and running. If it is not, tell me how to install it and stop.
2. Ask me for two folders: my media folder, and a folder for the server's settings. Create the settings folder if it does not exist.
3. Inside the media folder, create these four folders if they are missing: Movies, TV Shows, Cartoon, Music. Do not move, rename, or delete any of my files.
4. Run this command, with my two folders in place of /path/to/media and /path/to/config:

docker run -d --name lumiere-server --restart unless-stopped \
  -p 5059:5058 \
  -v /path/to/media:/media \
  -v /path/to/config:/config \
  -v /var/run/docker.sock:/var/run/docker.sock \
  artsvit/lumiere-server:latest

5. Run docker ps and check that lumiere-server runs. If port 5059 is in use, use another port on the left of 5059:5058 and tell me the new number. If it does not start, read docker logs lumiere-server and tell me the reason.
6. Open http://localhost:5059 and check that the server page loads.
7. Tell me the address to use in the Lumière apps: the IP address of this machine and the port.

Do not open the server to the internet and do not add a port forward on the router. The server has no password of its own.

docker pull artsvit/lumiere-server:latest
docker rm -f lumiere-server

To keep your media read-only, add :ro after /media. The server then plays your files but cannot delete a title.

If the server cannot read your files or write to the settings folder, add - PUID=1000 and - PGID=1000 under environment:. Use the numbers of the user who owns the folders. To see them, run id in a terminal.

Lumière Server for Synology

Requires DSM 7.2 or later with Container Manager

1. Install Container Manager from Package Center.
2. Open Container Manager. Select Project, then Create.
3. Give the project a name and a folder, for example /volume1/docker/lumiere.
4. Select Create docker-compose.yml and paste the text below.
5. Change /volume1/video to the shared folder with your media.
6. Finish the wizard. Then open http://<NAS address>:5059 in a browser.

services:
  lumiere-server:
    image: artsvit/lumiere-server:latest
    container_name: lumiere-server
    restart: unless-stopped
    ports:
      - "5059:5058"
    dns:
      - 1.1.1.1
      - 8.8.8.8
    volumes:
      - /volume1/video:/media
      - /volume1/docker/lumiere/config:/config
      - /var/run/docker.sock:/var/run/docker.sock

Each subfolder of your media folder is a library. Name them Movies, TV Shows, Cartoon, or Music.

The two dns lines let the container look up internet names. Many NAS systems give containers no working DNS, and then posters and music details do not load.

If the server cannot read your files, add PUID and PGID under environment: with the numbers of your DSM user, for example - PUID=1026 and - PGID=100. To see the numbers, run id <user> in an SSH session.

To update, select your project in Container Manager, then Action, then Build. Your settings stay in the config folder.

Lumière Server for other NAS systems

For QNAP, Unraid, TrueNAS, ASUSTOR, and other systems that run Docker containers

1. Open the container app of your NAS, for example Container Station on QNAP or the Docker tab on Unraid.
2. Add a container from the image artsvit/lumiere-server:latest.
3. Publish port 5059 of the NAS to port 5058 of the container.
4. Connect your media folder to /media and a settings folder to /config.
5. Connect the file /var/run/docker.sock to the same path in the container. It lets Update now in the server’s Settings update the server for you.
6. If your NAS has a DNS setting for containers, enter 1.1.1.1 and 8.8.8.8. Posters and music details need it on some systems.
7. Start the container. Then open http://<NAS address>:5059 in a browser.

If your NAS accepts a Compose file, use the file from the Docker tab.