psycho0verload/directorylister repository overview

Directory Lister is the easiest way to expose the contents of any web-accessible folder for browsing and sharing. With a zero configuration, drag-and-drop installation you'll be up and running in less than a minute.

• Directory Lister is created and maintained by Chris Kankiewicz⁠ (@PHLAK⁠) with help from community contributions⁠.
• Docker-Version⁠ is created and maintained by Jonathan Starck⁠ (@psycho0verload⁠)

⁠Features

• Simple installation allows you to be up and running in less than a minute.
• Light and dark themes to suit your professional needs or personal style.
• Custom sort ordering gives you control of the ordering of your files/folders.
• File search helps you locate the files you need quickly and efficiently.
• File hashes instill confidence when downloading files through verification.
• Readme rendering allows exposing the contents of READMEs directly on the page.
• Zip downloads for fetching an entire directory of files in a single action.
• Multi-lingual support brings Directory Lister to the language of your choice.

⁠How to Use

⁠Basic Setup with Custom Configuration

To get started, navigate to a directory of your choice and create a 'config' folder. Within this 'config' folder, generate an .env file, as shown in the directory structure below:

.
├── config
│   └── .env
├── docker-compose.yml
└── files

Your .env file should contain the following settings:

APP_DEBUG=false
APP_LANGUAGE=en

DISPLAY_READMES=true
READMES_FIRST=false
ZIP_DOWNLOADS=true

GOOGLE_ANALYTICS_ID=false

MATOMO_ANALYTICS_URL=false
MATOMO_ANALYTICS_ID=false

SORT_ORDER=type
REVERSE_SORT=false

For additional information on configuration options, please refer to the Configuration Documentation⁠.

The docker-compose.yml file should look like this:

version: '3.9'
services:
  directorylister:
    image: psycho0verload/directorylister:latest
    restart: unless-stopped
    volumes:
      - ./files:/var/www/html/
      - ./config/.env:/var/www/html/.env
    ports:
      - "80:8080"

⁠Sponsors

Love Directory Lister? Sponsor development⁠ and have your name or logo featured here!

⁠Copyright

This project is licensed under the MIT License⁠.