handler

package

v0.0.8 Latest Latest Go to latest Published: Aug 13, 2023 License: Unlicense Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mxmCherry/fx-server

Documentation ¶

Index ¶

func New(storage Storage, cfg *Config) http.Handler
type Config
type Storage

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func New ¶

func New(storage Storage, cfg *Config) http.Handler

New constructs a new file-exchange handler.

It has the following routes: a) GET / - serve upload page c) POST / - handle upload, always sets X-Upload-Hash response header b) GET /{hash} - serve file

If cfg.AuthRead is provided, it demands HTTP Basic auth for read operations (GET-s). If cfg.AuthWrite is provided, it demands HTTP Basic auth for write operations (POST-s).

If cfg.Oneshot is enabled, the handler works in oneshot mode: uploaded file is removed after first successful (2xx) download. Note: this is protected only with cfg.AuthRead.

If cfg.Aliasing is enabled, files can be downloaded like /{hash}.{ext} or /{hash}/{filename}.

Types ¶

type Config ¶ added in v0.0.6

type Config struct {
	AuthRead  map[string]string `split_words:"true"`
	AuthWrite map[string]string `split_words:"true"`
	Oneshot   bool              `default:"false"` // rm file after first successful serve
	Aliasing  bool              `default:"false"` // allow to alias file/ext on download (freeform)
}

Configig defines a file-exchange handler config.

type Storage ¶

type Storage interface {
	Create(io.Reader) (string, error)
	Path(string) (string, error)
	Remove(string) error
}

Storage defines a file storage abstraction.

Source Files ¶

View all Source files

handler.go

Directories ¶

Path	Synopsis
internal
respondwith

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL