README.md

   1 <h1 align="center"><code>dirlistozxa</code></h1>\r
   2 \r
   3 <p align="center"><img src="https://user-images.githubusercontent.com/60856959/235306666-4c66584a-f4c0-413e-bc58-09a724b02158.png"></p>\r
   4 \r
   5 A simple directory lister script in PHP that will show the files and directories in a directory, along with their modification date and size. Image thumbnail previews are also supported.\r
   6 \r
   7 ## Setting up\r
   8 To set up, set the PHP file to be the index file, if no `index.html` or `index.php` exists in the directory. An example for nginx would be:\r
   9 \r
  10 ```nginx\r
  11 index index.html index.php /dirlistozxa.php;\r
  12 ```\r
  13 \r
  14 You need to also move the `.dirlistozxa/` folder into the root of the site, such that it is accessible at `/.dirlistozxa/`.\r
  15 \r
  16 To optionally generate image thumbnails, use the `gen-thumbs` script. Requires Imagemagick to be installed, it will generate thumbnail files into `/.thumbs/`. If the script can't find any thumbnail for an image in `/.thumbs/`, it will just fall back to the generic file image.\r
  17 \r
  18 ## License\r
  19 `dirlistozxa` is licensed under the AGPLv3 license.\r