You've already forked filebrowser
mirror of
https://github.com/filebrowser/filebrowser.git
synced 2025-11-26 14:25:26 +08:00
Remove unused function and update docs
This commit is contained in:
39
doc.go
39
doc.go
@@ -1,10 +1,39 @@
|
||||
/*
|
||||
Package filemanager provides a web interface to access
|
||||
your files wherever you are.
|
||||
Package filemanager provides a web interface to access your files
|
||||
wherever you are. To use this package as a middleware for your app,
|
||||
you'll need to create a filemanager instance:
|
||||
|
||||
To use this package, you'll need to start by creating a
|
||||
filemanager instance:
|
||||
m, err := filemanager.New(database, user)
|
||||
|
||||
fm, err := New(database, user)
|
||||
Where 'user' contains the default options for new users. You can just
|
||||
use 'filemanager.DefaultUser'
|
||||
|
||||
Then, you should set the Prefix URL and the Base URL, using the following
|
||||
functions:
|
||||
|
||||
m.SetBaseURL("/")
|
||||
m.SetPrefixURL("/")
|
||||
|
||||
The Prefix URL is a part of the path that is already stripped from the
|
||||
r.URL.Path variable before the request arrives to File Manager's handler.
|
||||
This is a function that will rarely be used. You can see one example on Caddy
|
||||
filemanager plugin.
|
||||
|
||||
The Base URL is the URL path where you want File Manager to be available in. If
|
||||
you want to be available at the root path, you should call:
|
||||
|
||||
m.SetBaseURL("/")
|
||||
|
||||
But if you want to access it at '/admin', you would call:
|
||||
|
||||
m.SetBaseURL("/admin")
|
||||
|
||||
Now, that you already have a File Manager instance created, you just need to
|
||||
add it to your handlers using m.ServeHTTP which is compatible to http.Handler.
|
||||
We also have a m.ServeWithErrorsHTTP that returns the status code and an error.
|
||||
|
||||
One simple implementation for this, at port 80, in the root of the domain, would be:
|
||||
|
||||
http.ListenAndServe(":80", m)
|
||||
*/
|
||||
package filemanager
|
||||
|
||||
Reference in New Issue
Block a user