s3browser

README

Caddy s3browser

Example config

dl.example.com {
	s3browser {
		key ADDKEYHERE
		secret ADDSECRETHERE
		bucket ADDBUCKETHERE
		endpoint nyc3.digitaloceanspaces.com
		secure true
		refresh 5m
		debug false
	}
	proxy / https://examplebucket.nyc3.digitaloceanspaces.com {
		header_upstream Host examplebucket.nyc3.digitaloceanspaces.com
	}
}

This will provide directory listing for an S3 bucket (you are able to use minio, or other S3 providers). To serve files via Caddy as well you'll need to use the proxy directive as well. The server must be able to have public access to the files in the bucket.

Note: For performance reasons, the file listing is fetched once every 5minutes to reduce load on S3 (or S3 equivalent).

Prior Art

• This is based on the Browse plugin that is built into Caddy
• The template is based on the browse template from Webhippie
• s3server from jessfraz
• pretty-s3-index-html by Nolan Lawson

Documentation

Index

• func BoolArg(c *caddy.Controller) (bool, error)
• func StringArg(c *caddy.Controller) (string, error)
• type Browse
  • func (b Browse) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)
• type Config
• type Directory
  • func (d Directory) Breadcrumbs() []Node
  • func (d Directory) ReadableName() string
• type File
  • func (f File) HumanModTime(format string) string
  • func (f File) HumanSize() string
• type Folder
  • func (f Folder) ReadableName() string
• type Node

Functions

func BoolArg

func BoolArg(c *caddy.Controller) (bool, error)

func StringArg

func StringArg(c *caddy.Controller) (string, error)

Assert only one arg and return it

Types

type Browse

type Browse struct {
	Next     httpserver.Handler
	Config   Config
	Client   *minio.Client
	Fs       map[string]Directory
	Template *template.Template
}

func (Browse) ServeHTTP

func (b Browse) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

type Config

type Config struct {
	Key      string
	Bucket   string
	Secret   string
	Endpoint string
	Secure   bool
	Refresh  string
	Debug    bool
}

type Directory

type Directory struct {
	Path    string
	Folders []Folder
	Files   []File
}

func (Directory) Breadcrumbs

func (d Directory) Breadcrumbs() []Node

func (Directory) ReadableName

func (d Directory) ReadableName() string

type File

type File struct {
	Folder string
	Bytes  int64
	Name   string
	Date   time.Time
}

func (File) HumanModTime

func (f File) HumanModTime(format string) string

HumanModTime returns the modified time of the file as a human-readable string.

func (File) HumanSize

func (f File) HumanSize() string

HumanSize returns the size of the file as a human-readable string in IEC format (i.e. power of 2 or base 1024).

type Folder

type Folder struct {
	Name string
}

func (Folder) ReadableName

func (f Folder) ReadableName() string

type Node

type Node struct {
	Link         string
	ReadableName string
}