README.md

   1 # `dirlistozxa`\r
   2 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
   3 \r
   4 ## Setting up\r
   5 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
   6 \r
   7 ```nginx\r
   8 index index.html index.php /dirlistozxa.php;\r
   9 ```\r
  10 \r
  11 You need to also move the `.dirlistozxa/` folder into the root of the site, such that it is accessible at `/.dirlistozxa/`.\r
  12 \r
  13 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
  14 \r
  15 ## License\r
  16 `dirlistozxa` is licensed under the AGPLv3 license.\r