Go to file
Martin Nielsen 58d7f7b982
Merge pull request #1 from null4bl3/null4bl3-docker-compose-patch
Updated README.md for docker and docker-compose
2021-07-15 15:09:23 +02:00
.github chore: update issue templates (#1355) 2021-03-28 12:52:03 +02:00
.tx feat: add more languages (#773) 2019-06-09 13:31:57 +01:00
auth build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
cmd refactor: migrate from rice to embed.FS 2021-03-09 19:09:32 +01:00
diskcache fix: delete cached previews when deleting file 2020-07-28 11:59:55 +02:00
errors fix: don't allow to remove root user 2021-01-11 22:33:36 +01:00
files fix: omit file content 2021-04-23 12:04:02 +00:00
fileutils fix: move files between different volumes (closes #1177) 2020-12-24 17:50:27 +01:00
frontend feat: show more button on share 2021-04-23 11:59:34 +00:00
http fix: omit file content 2021-04-23 12:04:02 +00:00
img feat: add EXIF thumbnail support for JPEG files (#1234) 2021-03-29 11:40:00 +02:00
rules fix: hide dotfile error on share 2021-03-18 18:24:24 +00:00
runner fix: wait for async command exit (#1326) 2021-03-14 19:32:14 +01:00
scripts build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
search chore: refactor search function 2021-01-12 19:14:23 +01:00
settings feat: allow disabling file detections by reading header (#1175) 2021-01-07 11:30:17 +01:00
share feat: allow to password protect shares (#1252) 2021-03-02 12:00:18 +01:00
storage feat: allow to password protect shares (#1252) 2021-03-02 12:00:18 +01:00
users build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
version chore: versioning with ldflags (#726) 2019-05-12 21:08:43 +01:00
.docker.json fix: add missing default config into the docker image 2021-03-07 15:23:12 +01:00
.dockerignore feat: add health check handler 2021-03-21 12:30:48 +01:00
.gitignore chore: automatic output name on build 2021-03-15 14:00:23 +00:00
.golangci.yml build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
.goreleaser.yml refactor: migrate from rice to embed.FS 2021-03-09 19:09:32 +01:00
.versionrc build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
CHANGELOG.md chore(release): 2.15.0 2021-04-06 13:57:29 +02:00
commitlint.config.js build: use make for building the project (#1304) 2021-03-04 00:10:08 +01:00
Dockerfile feat: add health check handler 2021-03-21 12:30:48 +01:00
go.mod feat: add EXIF thumbnail support for JPEG files (#1234) 2021-03-29 11:40:00 +02:00
go.sum feat: add EXIF thumbnail support for JPEG files (#1234) 2021-03-29 11:40:00 +02:00
LICENSE chore: add circle ci and use external assets 2018-02-01 16:18:44 +00:00
main.go 🧹: gofmt 2019-01-05 23:01:16 +00:00
Makefile fix: short commit sha and typo fix in Makefile (#1411) 2021-05-25 11:29:38 +02:00
README.md Updated README.md for docker and docker-compose 2021-07-15 15:08:51 +02:00
SECURITY.md Create SECURITY.md 2021-07-03 16:56:27 +02:00

Preview

Build Go Report Card Documentation Version Chat IRC

filebrowser provides a file managing interface within a specified directory and it can be used to upload, delete, preview, rename and edit your files. It allows the creation of multiple users and each user can have its own directory. It can be used as a standalone app or as a middleware.

Features

Please refer to our docs at https://filebrowser.org/features

Install

For installation instructions please refer to our docs at https://filebrowser.org/installation.

##Docker

docker run \
    -v /path/to/root:/srv \
    -v /path/filebrowser.db:/database.db \
    -v /path/.filebrowser.json:/.filebrowser.json \
    --user $(id -u):$(id -g)
    -p 80:80 \
    filebrowser/filebrowser

Docker-compose

First of all, create to 2 needed files before running docker-compose

  • /local/path/to/database.db
  • /local/path/to/.filebrowser.json

The .filebrowser.json contains your configuration. The context of the settings in this file is in reference to the docker container, and does should not reflect your local environment.

{
  "port": 80,
  "baseURL": "",
  "address": "",
  "log": "stdout",
  "database": "/database.db",
  "root": "/srv"
}

Next you bring the docker container up with a similar docker-compose.yml file:

version: '3.3'
services:
    filebrowser:
        volumes:
            - '/local/path/to/shares:/srv'
            - '/local/path/to/database.db:/database.db'
            - '/local/path/to/.filebrowser.json:/.filebrowser.json:ro'
        ports:
            - '80:80'
        image: filebrowser/filebrowser
docker-compose up --build

Configuration

Authentication Method - You can change the way the user authenticates with the filebrowser server

Command Runner - The command runner is a feature that enables you to execute any shell command you want before or after a certain event.

Custom Branding - You can customize your File Browser installation by change its name to any other you want, by adding a global custom style sheet and by using your own logotype if you want.

Contributing

If you're interested in contributing to this project, our docs are best places to start https://filebrowser.org/contributing.