Skip to content
a simple file browser for nginx autoindex module
JavaScript HTML CSS Dockerfile
Branch: master
Clone or download

Latest commit

Latest commit dd38437 Dec 21, 2018

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
assets adding screenshots Feb 12, 2016
css adding copyright notices and co Feb 12, 2016
image adding sort by size and better error handling Feb 11, 2016
js adding some docs to main JS file Feb 15, 2016
.gitignore all the base and vendor files needed Feb 11, 2016
Dockerfile adding sample docker file and nginx config Feb 11, 2016
LICENSE adding license and readme Feb 12, 2016
README.md Fix your markdown Dec 10, 2018
default.conf using alias in nginx config for /files to save headaches Feb 15, 2016
index.html fixing mis-shaped link Jun 22, 2016

README.md

nginx file browser

This web application is a very simple file browser which can be used effectively together with nginx's autoindex module.

nginx file browser in action

A sample nginx configuration is also included which mounts file browser under root (/) and mounts files to be listed under /files path. Hence is the filesBaseUrl under

Using with docker

Mainly for demonstration purposes a docker image is also available here. In order to use this docker image, the volume which has to be served should be mounted under /opt/www/files/ and port 80 of container shall be mapped to a proper port on host. A proper run would look like:

$ docker run -p 8080:80 -v /path/to/my/files/:/opt/www/files/ mohamnag/nginx-file-browser

With container up and running you can point your browser to IP of docker host with given port to view the files. For example with above run command assuming docker host having IP with 192.168.0.200 we have to navigate to this URL:

http://192.168.0.200:8080

Symlinks

Be very careful with symlinks, they can expose very important files of system to outside world!

If you have symlinks inside files dir that you want to be able to browse too, the alias path where /files is served by nginx has to be changed to match the same path outside your docker container. Lets say I have a directory with path /home/myuser/files-to-serve/. Which has two directories named dir1 and dir2. where dir1 is nothing more than a symlink to dir2. In order to be able to browse dir1 (inside dir2) on file browser, following have to be done:

Inside default.conf this line

    alias /opt/www/files/;

shall be changed to

    alias /home/myuser/files-to-serve/;

And the mounting point is now /home/myuser/files-to-serve/ instead of /opt/www/files/.

You can’t perform that action at this time.