Update readme (#22)

This commit is contained in:
Graham Steffaniak 2023-09-10 09:08:21 -05:00 committed by GitHub
parent 8453cb54e8
commit 356c1f5888
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 39 additions and 1 deletions

View File

@ -138,8 +138,17 @@ All configuration is now done via a single configuration file: `filebrowser.yaml
View the [Configuration Help Page](./configuration.md) for available configuration options and other help. View the [Configuration Help Page](./configuration.md) for available configuration options and other help.
### background ### background & help
The original project filebrowser/filebrowser used multiple different ways to configure the server. The original project filebrowser/filebrowser used multiple different ways to configure the server.
This was confusing and difficult to work with from a user and from a developer's perspective. 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. So I completely redesigned the program to use one single human-readable config file.
I understand many coming from the original fork may notice differences which make using this improved version more difficult. If you notice issues that you believe should be fixed, please open an issue here and it will very likely be addressed with a PR within a few weeks.
This version of filebrowser is going through a configuration overhaul as mentioned above. Certain features related to rules and commands may not work as they do on the original filebrowser. The purpose of this is to create a more consistent experience where configuration is done via files rather than running commands, so that it's very clear what the current state of the configuration is. When running commands its not clear what the configuration is.
## Roadmap
see [Roadmap Page](./roadmap.md)

29
roadmap.md Normal file
View File

@ -0,0 +1,29 @@
# Planned Roadmap
Next release (0.2.1):
- Improve browsing directory performance by utilizing the index.
- Add editor themes back that were removed because of issues.
- Add "running config" which is editable in filebrowser settings to add rules, users, settings which would normally be done via commands.
- baseurl issue https://github.com/filebrowser/filebrowser/pull/2579
- https://github.com/filebrowser/filebrowser/issues/2526
- https://github.com/filebrowser/filebrowser/issues/2698
- https://github.com/filebrowser/filebrowser/pull/2667
- https://github.com/filebrowser/filebrowser/issues/2632
- https://github.com/filebrowser/filebrowser/issues/2619
- https://github.com/filebrowser/filebrowser/issues/2618
- https://github.com/filebrowser/filebrowser/issues/2607
Future releases (within 6 months):
- Allow multiple volumes to show up in the same filebrowser container. https://github.com/filebrowser/filebrowser/issues/2514
- enable/disable indexing for certain mounts
- Add tools to sidebar
- duplicate file detector.
- bulk rename https://github.com/filebrowser/filebrowser/issues/2473
- Add Job status to the sidebar - indexin status.
- Use vite instead of webpack
- upgrade to vue3
- support minio/s3 https://github.com/filebrowser/filebrowser/issues/2544
- https://github.com/filebrowser/filebrowser/issues/2537