vic/filebrozer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: move most docs to main repository (#5141)

Browse Source
This commit is contained in:
Henrique Dias
2025-06-17 11:37:15 +02:00
committed by GitHub
parent c34c0afecf
commit 0cca7d8dc0
15 changed files with 388 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -25,28 +25,28 @@ filebrowser provides a file managing interface within a specified directory and
[issues]: https://github.com/filebrowser/filebrowser/issues
[discussions]: https://github.com/filebrowser/filebrowser/discussions
## Demo
URL: https://demo.filebrowser.org/
Credentials: `demo`/`demo`
## Features
Please refer to our docs at [https://filebrowser.org/features](https://filebrowser.org/features)
File Browser is a **create-your-own-cloud-kind** of software where you can install it on a server, direct it to a path and then access your files through a nice web interface. You have many available features!
| Easy Login System | Sleek Interface | User Management |
| :----------------------: | :----------------------: | :----------------------: |
| ![](./docs/assets/1.jpg) | ![](./docs/assets/2.jpg) | ![](./docs/assets/3.jpg) |
| File Editing | Custom Commands | Customization |
| :----------------------: | :----------------------: | :----------------------: |
| ![](./docs/assets/4.jpg) | ![](./docs/assets/5.jpg) | ![](./docs/assets/6.jpg) |
## Install
For installation instructions please refer to our docs at [https://filebrowser.org/installation](https://filebrowser.org/installation).
For information on how to install File Browser, please check [docs/installation.md](./docs/installation.md).
## Configuration
[Authentication Method](https://filebrowser.org/configuration/authentication-method) - You can change the way the user authenticates with the filebrowser server
[Command Runner](https://filebrowser.org/configuration/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](https://filebrowser.org/configuration/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.
For information on how to configure File Browser, please check [docs/configuration.md](./docs/configuration.md).
## Contributing
If you're interested in contributing to this project, our docs are best places to start [https://filebrowser.org/contributing](https://filebrowser.org/contributing).
For information on how to contribute to the project, including how translations are managed, please check [docs/contributing.md](./docs/contributing.md).