1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/filebrowser_ynh.git synced 2024-09-03 18:36:05 +02:00
filebrowser_ynh/README.md
2023-02-26 10:46:44 +00:00

63 lines
2.7 KiB
Markdown

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Filebrowser for YunoHost
[![Integration level](https://dash.yunohost.org/integration/filebrowser.svg)](https://dash.yunohost.org/appci/app/filebrowser) ![Working status](https://ci-apps.yunohost.org/ci/badges/filebrowser.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/filebrowser.maintain.svg)
[![Install Filebrowser with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=filebrowser)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Filebrowser quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
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 or as a middleware.
**Shipped version:** 2.23.0~ynh4
## Screenshots
![Screenshot of Filebrowser](./doc/screenshots/spaces_-M8KDxOujDoPpJyJJ5_i_uploads_git-blob-9390768b0cbb83b1e7da55c0ae13ecd2d8fcb114_2.PNG)
## Disclaimers / important information
### Default credentials
```
username: admin
password: admin
```
You must change the password and, if you can, the username for the best security possible.
### Configuration
By default, the root path is set to `/home/yunohost.app/filebrowser`. You can choose a different root path in filebrowser configuration file: `/var/www/filebrowser/settings.json` and modify **root** entry as desired. (you may need to set the correct permissions for the new path).
## Documentation and resources
* Official app website: <https://filebrowser.org>
* Official admin documentation: <https://filebrowser.org/>
* Upstream app code repository: <https://github.com/filebrowser/filebrowser>
* YunoHost documentation for this app: <https://yunohost.org/app_filebrowser>
* Report a bug: <https://github.com/YunoHost-Apps/filebrowser_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/filebrowser_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/filebrowser_ynh/tree/testing --debug
or
sudo yunohost app upgrade filebrowser -u https://github.com/YunoHost-Apps/filebrowser_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>