view README.md @ 28:ce92f4d41714

Add support for displaying hidden files.
author edogawaconan <me@myconan.net>
date Thu, 30 Oct 2014 12:14:32 +0900
parents f9588ccb7a42
children e4f534198385
line wrap: on
line source

dirlist
=======

Using capability of nginx.

Basically, add this block

    location @lister {
      include fastcgi_params;
      fastcgi_pass unix:/tmp/php-fcgi.sock;

      // BEGIN -- only when using alias
      uninitialized_variable_warn off;
      fastcgi_param DL_DIR $dl_dir;
      // END ---- only when using alias

      fastcgi_param SCRIPT_FILENAME /path/to/index.php;
    }

(adjust the path to `index.php` and `php-fcgi`).

And whenever a directory needs to be autoindexed, add

    location / {
      try_files $uri @lister;
    }

.

Note that if the directory is aliased, `$dl_dir` (fastcgi `DL_DIR`) needs to be set.

    location /anime/win/ {
      set $dl_dir $request_filename;
      alias /srv/ftp/;
      try_files $uri @lister; // try_files "" @lister if the alias is
    }

And done. Probably also works with apache but I have no idea how to set it up.

Configurations
--------------

Here are some variables which changes how it behaves:

- `DL_DIR`: sets directory to be listed.
- `DL_SHOWALL`: show or hide files which name start with `.`. Set to `1` to show.

Upgrading
---------

When upgrading from 1.0.0, update nginx config accordingly.

License
-------

    Copyright 2014 edogawaconan <me@myconan.net>

    Permission to use, copy, modify, and/or distribute this software for any
    purpose with or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.

    THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
    MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.