server

type BasicAuthHandler ¶

type BasicAuthHandler struct {
	http.Handler

	// User/password pairs
	Credentials map[string]string
	// The authentication realm
	Realm string
}

BasicAuthHandler provides Basic Authorization.

func (h BasicAuthHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type DirEntryInfo ¶

type DirEntryInfo struct {
	Name      string
	IsDir     bool
	Size      int64
	HumanSize humanSizeInfo `json:"-"`
}

DirEntryInfo holds details for a directory entry.

type DirInfo ¶

type DirInfo struct {
	Name    string
	IsRoot  bool
	Entries []DirEntryInfo
}

DirInfo holds details about the directory being listed.

type DirectoryListingTemplate ¶

type DirectoryListingTemplate struct {
	Config DirectoryListingTemplateConfig
	// contains filtered or unexported fields
}

DirectoryListingTemplate is a template rendered for a directory.

func NewDirectoryListingTemplate(config DirectoryListingTemplateConfig) *DirectoryListingTemplate

func (t *DirectoryListingTemplate) RenderHTML(w http.ResponseWriter, path string, dir *File, sortColumn string, sortAsc bool) error

func (t *DirectoryListingTemplate) RenderJSON(w http.ResponseWriter, path string, dir *File, sortColumn string, sortAsc bool) error

type DirectoryListingTemplateConfig ¶

type DirectoryListingTemplateConfig struct {
	PathPrefix string
}

DirectoryListingTemplateConfig holds configuration for a DirectoryListingTemplate

type File ¶

type File struct {
	Info os.FileInfo
	// contains filtered or unexported fields
}

File is an entry of a FileSystem entry.

If the entry is a directory and the filesystem is configured to hide dotfiles, the directory will also not list dotfiles under it.

func NewFile(absPath string, hideDotFiles bool) (*File, error)

func (f File) AbsPath() string

func (f File) Readdir() ([]*File, error)

type FileHandler ¶

type FileHandler struct {
	FileSystem     FileSystem
	DirectoryIndex bool
	// contains filtered or unexported fields
}

FileHandler is an http.Handler which serves static files under the specified filesystem.

func NewFileHandler(fileSystem FileSystem, directoryIndex bool, pathPrefix string) *FileHandler

func (f FileHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type FileSize ¶

type FileSize float64

FileSize represent a file size as a float number.

func (f FileSize) String() string

type FileSystem ¶

type FileSystem struct {
	ResolveHTML          bool
	HideDotFiles         bool
	AllowOutsideSymlinks bool
	Root                 string
}

FileSystem provides acess to files and directories under a certain root. It can optionally optionally:

• serve .htm(l) files for the corresponding path without suffix, if the original path is not found
• hide dotfiles
• allow access to file/directories outside the filesystem root via symlinks

func (fs FileSystem) Open(name string) (*File, error)

func (fs FileSystem) OpenFile(name string) (*File, error)

type LoggingHandler ¶

type LoggingHandler struct {
	http.Handler
}

LoggingHandler wraps an http.Handler providing logging at startup.

func (h LoggingHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

type StaticServer ¶

type StaticServer struct {
	Config StaticServerConfig
}

StaticServer is a static HTTP server.

func NewStaticServer(config StaticServerConfig) (*StaticServer, error)

func (s *StaticServer) Run() error

func (s *StaticServer) Scheme() string

type StaticServerConfig ¶

type StaticServerConfig struct {
	Addr                    string
	AllowOutsideSymlinks    bool
	CSS                     string
	DebugAddr               string
	Dir                     string
	DisableH2               bool
	DisableIndex            bool
	DisableLookupWithSuffix bool
	Log                     bool
	PasswordFile            string
	RequestPathPrefix       string
	ShowDotFiles            bool
	TLSCert                 string
	TLSKey                  string
}

StaticServerConfig holds configuration options for a StaticServer.

func (c StaticServerConfig) IsHTTPS() bool

func (c StaticServerConfig) Port() uint16

func (c StaticServerConfig) Validate() error