From 6c443daf18bf5ca750230236bca5b21e09ca1fdd Mon Sep 17 00:00:00 2001 From: Graham Steffaniak Date: Sat, 29 Jul 2023 10:16:09 -0500 Subject: [PATCH] updated readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 480bac90..8d4a5b0b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## Gtstef fork of filebrowser +## Gtstef / filebrowser **Note: Intended to be used in docker only.** @@ -11,16 +11,17 @@ This fork makes the following significant changes to filebrowser for origin: 1. [ ] Preview enhancements - preview default view is constrained to files subwindow, which can be toggled to fullscreen. + 1. Improved and simplified GUI + - 1. [x] Updated version and dependencies - [x] uses latest npm and node version - [x] removes deprecated npm packages - [x] Updates golang dependencies - 1. [ ] Added authentication type - - [ ] Using bearer token with remote authentication server + 1. [ ] Moved all configurations to filebrowser.json. no more flags or binary operations to db ## About -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. +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. ## Install @@ -43,7 +44,7 @@ services: volumes: - '/path/to/folder:/srv' #- './database/:/database/' - #- './config.json:/.filebrowser.json' + - './config.json:/.filebrowser.json' ports: - '8080:80' image: gtstef/filebrowser:0.1.0 @@ -72,3 +73,9 @@ volumes: ## Configuration +All configuration is now done via the filebrowser.json config file. This was chosen because it works best with a docker first use case. + +Previously the primary way to configure filebrowser was via flags. But this quickly became cumbersome if you had many configurations to make + +The other method to configure was via `filebrowser config` commands which would write configurations to a db if it existed already. +When considering \ No newline at end of file