Directory Lister Docs

Installation ​

Installation of Directory Lister is fast and requires no configuration. Starting with Directory Lister v5.0 an official Docker image is provided as directorylister/directorylister.

Directory Lister Compose ​

Requirements

For a long-term installation we recommend Directory Lister Compose, a pre-packaged Docker Compose configuration for quick and easy container management.

  1. Start by cloning the repository to a location of your choosing

    console
    git clone https://github.com/DirectoryLister/directory-lister-compose.git /path/to/directory-lister

  2. Switch to the installation directory and initialize the configuration files

    console
    cd /path/to/directory-lister
make init

  3. Modify the environment variables in .env for your installation

  4. Run docker compose config to validate and confirm your configuration

  5. Run docker compose up -d to start the containers

Docker Compose ​

Requirements

The following is an example docker-compose.yaml file. For more information on docker compose and how to use this file see the Docker Compose documentation.

yaml
services:

  directory-lister:
    image: directorylister/directorylister:latest
    environment:
      # APP_LANGUAGE: en
      # DISPLAY_READMES: true
      # READMES_FIRST: false
      # ZIP_DOWNLOADS: true
      # TIMEZONE: America/Phoenix
      # See configuration docs for additional variables
    ports:
      - <host_port>:80
    volumes:
      - <host_path>:/data
      - app-cache:/var/www/html/app/cache
    restart: unless-stopped
    
volumes:
  app-cache: {}

IMPORTANT

Replace <host_path> with the path to the directory you'd like to list.

Replace <host_port> with the port you would like to expose the application on.

TIP

See the Configuration Reference for a full list of the available environment variables.

Docker Run ​

Requirements

Docker

You may use docker run to launch a stand-alone Docker container from the official Docker image. You may use this method to test Directory Lister but we do not recommended this option for long-term use.

bash
docker run --detach [--env ENVIRONMENT_VARIABLE=value] \
    --volume <host_path>:/data --publish <host_port>:80 \
    directorylister/directorylister:5

IMPORTANT

Replace <host_path> with the path to the directory you'd like to list.

Replace <host_port> with the port you would like to expose the application on.

TIP

You may pass one or more environment variables with multiple --env flags.

Manual Installation ​

Requirements

  1. Download Directory Lister
  2. Extract the zip/tar archive
  3. Copy extracted files/folders to your web server

Install with Composer ​

Requirements

bash
composer create-project phlak/directory-lister