README
¶
filedrop
Too lightweight file storage server with HTTP API.
Currently filedrop is implemented only as a library. Sections below also document ideas for standalone server. See issue #3.
HTTP API
POST single file to /filedrop to save it.
For example:
POST /filedrop/screenshot.png
Content-Type: image/png
Content-Length: XXXX
You will get response with full file URL, like this one:
http://example.com/filedrop/41a8f78c-ce06-11e8-b2ed-b083fe9824ac/screenshot.png
Actually only UUID is used for file access. So you can change last part of URL how you like:
http://example.com/filedrop/41a8f78c-ce06-11e8-b2ed-b083fe9824ac/amazing-screenshot.png
You can specify max-uses and store-time-secs to override default settings
from server configuration (however you can't set value higher then configured).
POST /filedrop/screenshot.png?max-uses=5&store-secs=3600
Following request will store file screenshot.png for one hour (3600 seconds) and allow it to be downloaded not more than 10 times.
Note To get https scheme in URLs downstream server should set header
X-HTTPS-Downstream to 1 (or you can also set HTTPSDownstream config option)
Authorization
filedrop supports very basic access control. Basically, it can execute SQL
query with contents of Authorization header and file name. If query returns 1 - access
will be allowed, if query returns 0 or fails - client will get 403.
Also if you are using filedrop as a library, you can instead just pass custom authorization callback.
See configuration example for details.
Installation
go get or clone this repo and build binary from filedropd package. Pass
path to configuration in first argument. You are perfect.
Configuration
Documented example is included in repo, check it out.
Embedding
If your backend server is written in Golang or you are not a big fan of microservices architecture - you can run filedrop server as part of your program. See documentation for details.
Documentation
¶
Index ¶
- Variables
- type AuthConfig
- type Config
- type DBConfig
- type LimitsConfig
- type Server
- func (s *Server) AddFile(contents io.Reader, contentType string, maxUses uint, storeUntil time.Time) (string, error)
- func (s *Server) Close() error
- func (s *Server) GetFile(fileUUID string) (r io.Reader, contentType string, err error)
- func (s *Server) OpenFile(fileUUID string) (io.Reader, error)
- func (s *Server) RemoveFile(fileUUID string) error
- func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)
Constants ¶
This section is empty.
Variables ¶
var ErrFileDoesntExists = errors.New("file doesn't exists")
Functions ¶
This section is empty.
Types ¶
type AuthConfig ¶
type Config ¶
type Config struct {
Limits LimitsConfig
DB DBConfig
DownloadAuth AuthConfig
UploadAuth AuthConfig
StorageDir string
HTTPSDownstream bool
}
var Default Config
type LimitsConfig ¶
type Server ¶
type Server struct {
DB *db
Conf Config
Logger *log.Logger
DebugLogger *log.Logger
// contains filtered or unexported fields
}
filedrop server structure, implements http.Handler.
func (*Server) AddFile ¶
func (s *Server) AddFile(contents io.Reader, contentType string, maxUses uint, storeUntil time.Time) (string, error)
AddFile adds file to storage and returns assigned UUID which can be directly substituted into URL.
func (*Server) GetFile ¶
GetFile opens file for reading.
Note that access using this function is equivalent to access through HTTP API, so it will count against usage count, for example. To avoid this use OpenFile(fileUUID).
func (*Server) RemoveFile ¶
RemoveFile removes file from database and underlying storage.
Source Files