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

updated readme

This commit is contained in:
Graham Steffaniak 2023-07-29 10:16:09 -05:00
parent 9fc47937c2
commit 6c443daf18
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,4 +1,4 @@
## Gtstef fork of filebrowser ## Gtstef / filebrowser
**Note: Intended to be used in docker only.** **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 1. [ ] 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. Improved and simplified GUI
-
1. [x] Updated version and dependencies 1. [x] Updated version and dependencies
- [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
1. [ ] Added authentication type 1. [ ] Moved all configurations to filebrowser.json. no more flags or binary operations to db
- [ ] Using bearer token with remote authentication server
## About ## 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 ## Install
@ -43,7 +44,7 @@ services:
volumes: volumes:
- '/path/to/folder:/srv' - '/path/to/folder:/srv'
#- './database/:/database/' #- './database/:/database/'
#- './config.json:/.filebrowser.json' - './config.json:/.filebrowser.json'
ports: ports:
- '8080:80' - '8080:80'
image: gtstef/filebrowser:0.1.0 image: gtstef/filebrowser:0.1.0
@ -72,3 +73,9 @@ volumes:
## Configuration ## 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