filebrowser/caddy/filemanager/README_NEW.md
Henrique Dias 2bce61df57 Update new readme
Former-commit-id: 7bc2df695dcb39b151493b5f2254bfd10478581c [formerly f4ed1d8d2ba99c7053754cb39008e56e073142b6] [formerly ef8a56414e98a243e17d03853d65f427adc72075 [formerly e973fc266c03074394b18c6359d25e502bc38edd]]
Former-commit-id: bf9d3af46549c799ade91644527285fbfce49fb7 [formerly bd25d0ea0fed84a4c982857ac7b9abf4602ab372]
Former-commit-id: ee50d7ef50e7bcb28f82e22303b7fa6f31c9ec6a
2017-07-08 15:29:40 +01:00

2.0 KiB

filemanager - a caddy plugin

filemanager provides WebDAV features and a file managing interface within the specified directory and it can be used to upload, delete, preview, rename and edit your files within that directory. It is an implementation of hacdias/filemanager library.

Note that if you are handling large files you might run into troubles due to the defaults of timeouts plugin. Check its documentation to learn more about that plugin.

For information about the working of filemanager itself, go to the main repository.

Get Started

To start using this plugin you just need to go to the download Caddy page and choose filemanager in the directives section. For further information on how Caddy works refer to its documentation.

Syntax

filemanager [baseurl] [scope] {
    database  path
}

All of the options above are optional.

  • baseurl is the URL where you will access the File Manager interface. Defaults to /.
  • scope is the path, relative or absolute, to the directory you want to browse in. Defaults to ./.
  • path is the database path where the settings that aren't included in the Caddyfile will be stored. By default, the database will be stored on .caddy folder and its name will be an hashed combination of the host and the baseurl. It is highly recommended to set this option. Otherwise, whenever you change the host or the baseurl, your settings will be lost or you will need to point to the previous database.

Examples

Show the directory where Caddy is being executed at the root of the domain:

filemanager

Show the content of foo at the root of the domain:

filemanager / ./foo

Show the directory where Caddy is being executed at /filemanager:

filemanager /filemanager

Show the content of foo at /bar:

filemanager /bar /show