mirror of
https://github.com/filebrowser/filebrowser.git
synced 2025-05-09 19:52:58 +00:00
f6aeb27ca4
Former-commit-id: fa736cdab1636fa38bcf895d23b4a81c48eff0b6 [formerly d05e6cf88a7c0f7791131ce8612a0fdb9fe0129a] [formerly cf79c727c9e40fb3831b1b333e32f4d65bf2f122 [formerly 18414dbc5e4345c5f23975645be5192a941f6fb1]] Former-commit-id: d0aad221109a4940426ee47f8b8046f660918b74 [formerly 101bed38ef97803c8b38a5f7820b526608570666] Former-commit-id: eeb8f07063aaf131993b529d252cc991e7672aa7
53 lines
2.3 KiB
Markdown
53 lines
2.3 KiB
Markdown
# 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](https://github.com/hacdias/filemanager) library.
|
|
|
|
Note that if you are handling large files you might run into troubles due to the defaults of [`timeouts`](https://caddyserver.com/docs/timeouts) plugin. Check its [documentation](https://caddyserver.com/docs/timeouts) to learn more about that plugin. For information about the working of filemanager itself, go to the [main repository](https://github.com/hacdias/filemanager).
|
|
|
|
## Get Started
|
|
|
|
To start using this plugin you just need to go to the [download Caddy page](https://caddyserver.com/download) and choose `filemanager` in the directives section. For further information on how Caddy works refer to [its documentation](https://caddyserver.com/docs).
|
|
|
|
The default credentials are `admin` for the user and the password. It is highy recommended to change this after logging in for the first time and to use HTTPS. In the web interface, you can create more users and define their own permissions.
|
|
|
|
## 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
|
|
```
|