chiu
/
filebrowser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

Update README.md

This commit is contained in:
Graham Steffaniak 2023-09-03 12:40:09 -05:00 committed by GitHub
parent f2811ae54d
commit 7a1a360e5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,6 +1,10 @@
## Gtstef / filebrowser ## Gtstef / filebrowser
**Note: Intended to be used in docker only.** > **NOTE**
Intended for docker use only
> **Warning**
Starting with v0.2.0, *ALL* configuration is done via `filebrowser.yml` configuration file. `.filebrowser.json` and any flags used during execution WILL NO LONGER WORK. This is by design, in order to use the v0.2.0 You can mount your directory and initialize a new DB with a new default `filebrowser.yaml` which you can tweak and use in the future. Or you can copy and paste the default startup `filebrowser.yaml` below.
This fork makes the following significant changes to filebrowser for origin: This fork makes the following significant changes to filebrowser for origin:
@ -9,7 +13,7 @@ This fork makes the following significant changes to filebrowser for origin:
- [x] Realtime results as you type - [x] Realtime results as you type
- [x] Works with file type filter - [x] Works with file type filter
- [x] better desktop search view - [x] better desktop search view
1. [ ] Preview enhancements 1. [x] Preview enhancements
- Preview default view is constrained to files subwindow, - Preview default view is constrained to files subwindow,
which can be toggled to fullscreen. which can be toggled to fullscreen.
1. [x] Improved and simplified GUI 1. [x] Improved and simplified GUI
@ -20,11 +24,8 @@ This fork makes the following significant changes to filebrowser for origin:
- [x] Uses latest npm and node version - [x] Uses latest npm and node version
- [x] Removes deprecated npm packages - [x] Removes deprecated npm packages
- [x] Updates golang dependencies - [x] Updates golang dependencies
- [ ] Remove all unnecessary packages, replaces with generic functions. - [x] Remove all unnecessary packages, replaces with generic functions.
1. [ ] Moved all configurations to filebrowser.json. 1. [x] **IMPORTANT** Moved all configurations to `filebrowser.yaml`. no more flags or binary operations to db
no more flags or binary operations to db
1. [ ] File browsing uses index first for better performance
- file details shown only when toggled or needed
## About ## About
@ -125,14 +126,9 @@ volumes:
## Configuration ## Configuration
Note: still a WIP migrating configuration to json. All configuration is now done via a single configuration file: `filebrowser.yaml`, here is an example [configuration file](./backend/filebrowser.yaml).
### background
All configuration is now done via the filebrowser.json config file. The original project filebrowser/filebrowser used multiple different ways to configure the server.
This was chosen because it works best with a docker first use case. This was confusing and difficult to work with from a user and from a developer's perspective.
So I completely redesigned the program to use one single human-readable config file.
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