mirror of
https://github.com/filebrowser/filebrowser.git
synced 2025-05-09 11:42:57 +00:00
73eb1950a0
Former-commit-id: 526e9c3b22e35bdf4e1a20133be9677a84c855b3 [formerly c32f0e71e758cda14ad3e7174cac5c61e18683ac] [formerly 31e8a1808321a0fc95e9c1ce382d6267987c797f [formerly 465b10a02aef310ad05d1484a860db78f998625d]] Former-commit-id: 577ddb9013d6f993b24eb3ee2f9650f82a22be90 [formerly 8c4e05b2f3f2e46020c507744a3424e93512102f] Former-commit-id: d4df957be2535cf8bdbc891ebf52d68450f03b18
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 both the user and the password. It is highy recommended to change them after logging in for the first time and to use HTTPS. You can create more users and define their own permissions using the web interface.
|
|
|
|
## Syntax
|
|
|
|
```
|
|
filemanager [baseurl] [scope] {
|
|
database path
|
|
}
|
|
```
|
|
|
|
`baseurl` is the URL path where you will access File Manager. Defaults to `/`.
|
|
|
|
`scope` is the path, relative or absolute, to the directory you want to browse in. This value will be used for the creation of the first user. Defaults to `./`.
|
|
|
|
`path` is the database path where the settings will be stored. By default, the database will be stored on `.caddy/filemanager` folder and its name will be an hashed combination of the host and the `baseurl`. If you use a relative path it will be relative to `.caddy/filemanager`. Despite being optional, it is **highly** recommended to set this option in order to keep the settings when you change the `baseurl` and/or the hostname.
|
|
|
|
## 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
|
|
```
|