Installation

Use the image from Docker Hub.

docker run -d -p 8080:80 -v /my/local/folder:/var/www/html/public:ro -v rdb:/var/lib/redis/ adrianschubek/dir-browser

Replace /my/local/folder with the folder you want to serve. 8080 is the host port.

Access the directory browser at http://localhost:8080.

tip

You may want to run the container with the --restart always flag to ensure that the container is always running even after a system reboot.

Configuration

To set configuration options you can use docker run

• with the -e THEME=cosmo -e DATE_FORMAT=local arguments
• or load it from an environment file using --env-file .env.

.env

THEME=cosmo
DATE_FORMAT=local

Docker Compose

You can also use Docker Compose to run the container.

docker-compose.yml

services:
  dir-browser:
    image: adrianschubek/dir-browser:latest
    restart: unless-stopped
    ports:
      - "8080:80"
    volumes:
      - /my/local/folder:/var/www/html/public:ro
      - rdb:/var/lib/redis/
    environment:
      THEME: cosmo
      DATE_FORMAT: local

volumes:
  rdb:

info

If you are using a reverse proxy you may want the dir-browser to be accessible only from the reverse proxy. In this case you should modify the ports section and add 127.0.0.1 before the port number.

    ports: 
     - 8080:80
     - 127.0.0.1:8080:80

Updating

To update the container, simply pull the latest image from Docker Hub, remove the container and start it again.

tip

Find the container ID using docker ps.

docker pull adrianschubek/dir-browser:latest
docker rm -f <containerID>
docker run -d -p 8080:80 -v /my/local/folder:/var/www/html/public:ro -v rdb:/var/lib/redis/ adrianschubek/dir-browser:latest

If you are using Docker Compose, update with:

docker compose pull
docker compose up -d