v1.11.0 Latest Latest

This package is not in the latest version of its module.

Go to latest
Published: Jan 5, 2019 License: Apache-2.0 Imports: 32 Imported by: 12



Package filebrowser 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 import both File Browser and File Browser HTTP packages.

import (
	fm ""
	h ""

Then, you should create a new FileBrowser object with your options. In this case, I'm using BoltDB (via Storm package) as a Store. So, you'll also need to import "".

db, _ := storm.Open("bolt.db")

m := &fm.FileBrowser{
	NoAuth: false,
	Auth: {
		Method: "default",
		LoginHeader: "X-Fowarded-User"
	DefaultUser: &fm.User{
		AllowCommands: true,
		AllowEdit:     true,
		AllowNew:      true,
		AllowPublish:  true,
		Commands:      []string{"git"},
		Rules:         []*fm.Rule{},
		Locale:        "en",
		CSS:           "",
		Scope:         ".",
		FileSystem:    fileutils.Dir("."),
	Store: &fm.Store{
		Config: bolt.ConfigStore{DB: db},
		Users:  bolt.UsersStore{DB: db},
		Share:  bolt.ShareStore{DB: db},
	NewFS: func(scope string) fm.FileSystem {
		return fileutils.Dir(scope)

The credentials for the first user are always 'admin' for both the user and the password, and they can be changed later through the settings. The first user is always an Admin and has all of the permissions set to 'true'.

Then, you should set the Prefix URL and the Base URL, using the following functions:


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 Browser'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 Browser to be available in. If you want to be available at the root path, you should call:


But if you want to access it at '/admin', you would call:


Now, that you already have a File Browser 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", h.Handler(m))



View Source
const (
	// Version is the current File Browser version.
	Version = "v1.11.0"

	ListViewMode   = "list"
	MosaicViewMode = "mosaic"


View Source
var (
	ErrExist              = errors.New("the resource already exists")
	ErrNotExist           = errors.New("the resource does not exist")
	ErrEmptyRequest       = errors.New("request body is empty")
	ErrEmptyPassword      = errors.New("password is empty")
	ErrEmptyUsername      = errors.New("username is empty")
	ErrEmptyScope         = errors.New("scope is empty")
	ErrWrongDataType      = errors.New("wrong data type")
	ErrInvalidUpdateField = errors.New("invalid field to update")
	ErrInvalidOption      = errors.New("invalid option")
View Source
var DefaultUser = User{
	AllowCommands: true,
	AllowEdit:     true,
	AllowNew:      true,
	AllowPublish:  true,
	LockPassword:  false,
	Commands:      []string{},
	Rules:         []*Rule{},
	CSS:           "",
	Admin:         true,
	Locale:        "",
	Scope:         ".",
	FileSystem:    fileutils.Dir("."),
	ViewMode:      "mosaic",

DefaultUser is used on New, when no 'base' user is provided.


func CheckPasswordHash

func CheckPasswordHash(password, hash string) bool

CheckPasswordHash compares a password with an hash to check if they match.

func GenerateRandomBytes

func GenerateRandomBytes(n int) ([]byte, error)

GenerateRandomBytes returns securely generated random bytes. It will return an fm.Error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func HashPassword

func HashPassword(password string) (string, error)

HashPassword generates an hash from a password using bcrypt.


type Auth

type Auth struct {
	// Define if which of the following authentication mechansims should be used:
	// - 'default', which requires a user and a password.
	// - 'proxy', which requires a valid user and the user name has to be provided through an
	//   http header.
	// - 'none', which allows anyone to access the filebrowser instance.
	Method string
	// If 'Method' is set to 'proxy' the header configured below is used to identify the user.
	Header string

Auth settings.

type Command

type Command func(r *http.Request, m *FileBrowser, u *User) error

Command is a command function.

type ConfigStore

type ConfigStore interface {
	Get(name string, to interface{}) error
	Save(name string, from interface{}) error

ConfigStore is the interface to manage configuration.

type Context

type Context struct {
	User *User
	File *File
	// On API handlers, Router is the APi handler we want.
	Router string

Context contains the needed information to make handlers work.

type FSBuilder

type FSBuilder func(scope string) FileSystem

FSBuilder is the File System Builder.

type File

type File struct {
	// Indicates the Kind of view on the front-end (Listing, editor or preview).
	Kind string `json:"kind"`
	// The name of the file.
	Name string `json:"name"`
	// The Size of the file.
	Size int64 `json:"size"`
	// The absolute URL.
	URL string `json:"url"`
	// The extension of the file.
	Extension string `json:"extension"`
	// The last modified time.
	ModTime time.Time `json:"modified"`
	// The File Mode.
	Mode os.FileMode `json:"mode"`
	// Indicates if this file is a directory.
	IsDir bool `json:"isDir"`
	// Absolute path.
	Path string `json:"path"`
	// Relative path to user's virtual File System.
	VirtualPath string `json:"virtualPath"`
	// Indicates the file content type: video, text, image, music or blob.
	Type string `json:"type"`
	// Stores the content of a text file.
	Content string `json:"content,omitempty"`

	*Listing `json:",omitempty"`

	Metadata string `json:"metadata,omitempty"`
	Language string `json:"language,omitempty"`

File contains the information about a particular file or directory.

func GetInfo

func GetInfo(url *url.URL, c *FileBrowser, u *User) (*File, error)

GetInfo gets the file information and, in case of error, returns the respective HTTP error code

func (File) CanBeEdited

func (i File) CanBeEdited() bool

CanBeEdited checks if the extension of a file is supported by the editor

func (File) Checksum

func (i File) Checksum(algo string) (string, error)

Checksum retrieves the checksum of a file.

func (*File) GetEditor

func (i *File) GetEditor() error

GetEditor gets the editor based on a Info struct

func (*File) GetFileType

func (i *File) GetFileType(checkContent bool) error

GetFileType obtains the mimetype and converts it to a simple type nomenclature.

func (*File) GetListing

func (i *File) GetListing(u *User, r *http.Request) error

GetListing gets the information about a specific directory and its files.

type FileBrowser

type FileBrowser struct {
	// Cron job to manage schedulings.
	Cron *cron.Cron

	// The key used to sign the JWT tokens.
	Key []byte

	// The static assets.
	Assets *rice.Box

	// The Store is used to manage users, shareable links and
	// other stuff that is saved on the database.
	Store *Store

	// PrefixURL is a part of the URL that is already trimmed from the request URL before it
	// arrives to our handlers. It may be useful when using File Browser as a middleware
	// such as in caddy-filemanager plugin. It is only useful in certain situations.
	PrefixURL string

	// BaseURL is the path where the GUI will be accessible. It musn't end with
	// a trailing slash and mustn't contain PrefixURL, if set. It shouldn't be
	// edited directly. Use SetBaseURL.
	BaseURL string

	// Authentication configuration.
	Auth *Auth

	// ReCaptcha host, key and secret.
	ReCaptcha *ReCaptcha

	// StaticGen is the static websit generator handler.
	StaticGen StaticGen

	// The Default User needed to build the New User page.
	DefaultUser *User

	// A map of events to a slice of commands.
	Commands map[string][]string

	// Global stylesheet.
	CSS string

	// NewFS should build a new file system for a given path.
	NewFS FSBuilder

FileBrowser is a file manager instance. It should be creating using the 'New' function and not directly.

func (*FileBrowser) Attach

func (m *FileBrowser) Attach(s StaticGen) error

Attach attaches a static generator to the current File Browser.

func (FileBrowser) RootURL

func (m FileBrowser) RootURL() string

RootURL returns the actual URL where File Browser interface can be accessed.

func (FileBrowser) Runner

func (m FileBrowser) Runner(event string, path string, destination string, user *User) error

Runner runs the commands for a certain event type.

func (*FileBrowser) SetBaseURL

func (m *FileBrowser) SetBaseURL(url string)

SetBaseURL updates the baseURL of a File Browser object.

func (*FileBrowser) SetPrefixURL

func (m *FileBrowser) SetPrefixURL(url string)

SetPrefixURL updates the prefixURL of a File Manager object.

func (*FileBrowser) Setup

func (m *FileBrowser) Setup() error

Setup loads the configuration from the database and configures the Assets and the Cron job. It must always be run after creating a File Browser object.

func (FileBrowser) ShareCleaner

func (m FileBrowser) ShareCleaner()

ShareCleaner removes sharing links that are no longer active. This function is set to run periodically.

type FileSystem

type FileSystem interface {
	Mkdir(name string, perm os.FileMode) error
	OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
	RemoveAll(name string) error
	Rename(oldName, newName string) error
	Stat(name string) (os.FileInfo, error)
	Copy(src, dst string) error

FileSystem is the interface to work with the file system.

type Listing

type Listing struct {
	// The items (files and folders) in the path.
	Items []*File `json:"items"`
	// The number of directories in the Listing.
	NumDirs int `json:"numDirs"`
	// The number of files (items that aren't directories) in the Listing.
	NumFiles int `json:"numFiles"`
	// Which sorting order is used.
	Sort string `json:"sort"`
	// And which order.
	Order string `json:"order"`

A Listing is the context used to fill out a template.

func (Listing) ApplySort

func (l Listing) ApplySort()

ApplySort applies the sort order using .Order and .Sort

type ReCaptcha

type ReCaptcha struct {
	Host   string
	Key    string
	Secret string

ReCaptcha settings.

type Regexp

type Regexp struct {
	Raw string `json:"raw"`
	// contains filtered or unexported fields

Regexp is a regular expression wrapper around native regexp.

func (*Regexp) MatchString

func (r *Regexp) MatchString(s string) bool

MatchString checks if this string matches the regular expression.

type Rule

type Rule struct {
	// Regex indicates if this rule uses Regular Expressions or not.
	Regex bool `json:"regex"`

	// Allow indicates if this is an allow rule. Set 'false' to be a disallow rule.
	Allow bool `json:"allow"`

	// Path is the corresponding URL path for this rule.
	Path string `json:"path"`

	// Regexp is the regular expression. Only use this when 'Regex' was set to true.
	Regexp *Regexp `json:"regexp"`

Rule is a dissalow/allow rule.

type ShareLink struct {
	Hash       string    `json:"hash" storm:"id,index"`
	Path       string    `json:"path" storm:"index"`
	Expires    bool      `json:"expires"`
	ExpireDate time.Time `json:"expireDate"`

ShareLink is the information needed to build a shareable link.

type ShareStore

type ShareStore interface {
	Get(hash string) (*ShareLink, error)
	GetPermanent(path string) (*ShareLink, error)
	GetByPath(path string) ([]*ShareLink, error)
	Gets() ([]*ShareLink, error)
	Save(s *ShareLink) error
	Delete(hash string) error

ShareStore is the interface to manage share links.

type StaticGen

type StaticGen interface {
	SettingsPath() string
	Name() string
	Setup() error

	Hook(c *Context, w http.ResponseWriter, r *http.Request) (int, error)
	Preview(c *Context, w http.ResponseWriter, r *http.Request) (int, error)
	Publish(c *Context, w http.ResponseWriter, r *http.Request) (int, error)

StaticGen is a static website generator.

type Store

type Store struct {
	Users  UsersStore
	Config ConfigStore
	Share  ShareStore

Store is a collection of the stores needed to get and save information.

type User

type User struct {
	// ID is the required primary key with auto increment0
	ID int `storm:"id,increment"`

	// Tells if this user is an admin.
	Admin bool `json:"admin"`

	// These indicate if the user can perform certain actions.
	AllowCommands bool `json:"allowCommands"` // Execute commands
	AllowEdit     bool `json:"allowEdit"`     // Edit/rename files
	AllowNew      bool `json:"allowNew"`      // Create files and folders
	AllowPublish  bool `json:"allowPublish"`  // Publish content (to use with static gen)

	// Prevents the user to change its password.
	LockPassword bool `json:"lockPassword"`

	// Commands is the list of commands the user can execute.
	Commands []string `json:"commands"`

	// Custom styles for this user.
	CSS string `json:"css"`

	// FileSystem is the virtual file system the user has access.
	FileSystem FileSystem `json:"-"`

	// Locale is the language of the user.
	Locale string `json:"locale"`

	// The hashed password. This never reaches the front-end because it's temporarily
	// emptied during JSON marshall.
	Password string `json:"password"`

	// Rules is an array of access and deny rules.
	Rules []*Rule `json:"rules"`

	// Scope is the path the user has access to.
	Scope string `json:"filesystem"`

	// Username is the user username used to login.
	Username string `json:"username" storm:"index,unique"`

	// User view mode for files and folders.
	ViewMode string `json:"viewMode"`

User contains the configuration for each user.

func (User) Allowed

func (u User) Allowed(url string) bool

Allowed checks if the user has permission to access a directory/file.

type UsersStore

type UsersStore interface {
	Get(id int, builder FSBuilder) (*User, error)
	GetByUsername(username string, builder FSBuilder) (*User, error)
	Gets(builder FSBuilder) ([]*User, error)
	Save(u *User) error
	Update(u *User, fields ...string) error
	Delete(id int) error

UsersStore is the interface to manage users.


Path Synopsis

Jump to

Keyboard shortcuts

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