Update README.md
shammel7
GitHub
parent
d41af76f34
commit
d00fe1334b
77
README.md
77
README.md
|
|
@ -1,39 +1,70 @@
|
|||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/filebrowser/logo/master/banner.png" width="550"/>
|
||||
</p>
|
||||
<div align="center">
|
||||
<img src="https://raw.githubusercontent.com/filebrowser/logo/master/banner.png" width="550" alt="File Browser Banner" />
|
||||
</div>
|
||||
|
||||
|
||||
---
|
||||
|
||||
[](https://github.com/filebrowser/filebrowser/actions/workflows/main.yaml)
|
||||
[](https://goreportcard.com/report/github.com/filebrowser/filebrowser)
|
||||
[](http://godoc.org/github.com/filebrowser/filebrowser)
|
||||
[](https://github.com/filebrowser/filebrowser/releases/latest)
|
||||
[](http://webchat.freenode.net/?channels=%23filebrowser)
|
||||
<div align="center">
|
||||
<img src="https://user-images.githubusercontent.com/5447088/50716739-ebd26700-107a-11e9-9817-14230c53efd2.gif" alt="File Browser Preview" />
|
||||
</div>
|
||||
|
||||
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.
|
||||
---
|
||||
|
||||
## Demo
|
||||
<div align="center">
|
||||
<a href="https://github.com/filebrowser/filebrowser/actions/workflows/main.yaml">
|
||||
<img src="https://github.com/filebrowser/filebrowser/actions/workflows/main.yaml/badge.svg" alt="Build Status" />
|
||||
</a>
|
||||
<a href="https://goreportcard.com/report/github.com/filebrowser/filebrowser">
|
||||
<img src="https://goreportcard.com/badge/github.com/filebrowser/filebrowser?style=flat-square" alt="Go Report Card" />
|
||||
</a>
|
||||
<a href="http://godoc.org/github.com/filebrowser/filebrowser">
|
||||
<img src="https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square" alt="Documentation" />
|
||||
</a>
|
||||
<a href="https://github.com/filebrowser/filebrowser/releases/latest">
|
||||
<img src="https://img.shields.io/github/release/filebrowser/filebrowser.svg?style=flat-square" alt="Latest Release" />
|
||||
</a>
|
||||
<a href="http://webchat.freenode.net/?channels=%23filebrowser">
|
||||
<img src="https://img.shields.io/badge/freenode-%23filebrowser-blue.svg?style=flat-square" alt="Chat on Freenode" />
|
||||
</a>
|
||||
</div>
|
||||
|
||||
url: https://demo.filebrowser.org/
|
||||
---
|
||||
|
||||
credentials: `demo`/`demo`
|
||||
# File Browser
|
||||
|
||||
## Features
|
||||
**File Browser** provides a file management interface within a specified directory. It allows you to upload, delete, preview, rename, and edit files. With support for multiple users, each user can have a unique directory. File Browser can also be used as a standalone application.
|
||||
|
||||
Please refer to our docs at [https://filebrowser.org/features](https://filebrowser.org/features)
|
||||
---
|
||||
|
||||
## Install
|
||||
## 🛠️ Features
|
||||
Explore all the features in the [official documentation](https://filebrowser.org/features).
|
||||
|
||||
For installation instructions please refer to our docs at [https://filebrowser.org/installation](https://filebrowser.org/installation).
|
||||
---
|
||||
|
||||
## Configuration
|
||||
## 🚀 Demo
|
||||
- **URL**: [https://demo.filebrowser.org/](https://demo.filebrowser.org/)
|
||||
- **Credentials**: `demo` / `demo`
|
||||
|
||||
[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.
|
||||
## 📥 Installation
|
||||
Follow the installation guide at [https://filebrowser.org/installation](https://filebrowser.org/installation).
|
||||
|
||||
[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.
|
||||
---
|
||||
|
||||
## Contributing
|
||||
## ⚙️ Configuration
|
||||
File Browser supports a variety of configurations:
|
||||
- **[Authentication Method](https://filebrowser.org/configuration/authentication-method):** Change how users authenticate with the server.
|
||||
- **[Command Runner](https://filebrowser.org/configuration/command-runner):** Execute shell commands before or after specific events.
|
||||
- **[Custom Branding](https://filebrowser.org/configuration/custom-branding):** Customize File Browser by changing its name, adding a global custom style sheet, or using your own logo.
|
||||
|
||||
If you're interested in contributing to this project, our docs are best places to start [https://filebrowser.org/contributing](https://filebrowser.org/contributing).
|
||||
---
|
||||
|
||||
## 🤝 Contributing
|
||||
Interested in contributing? Start with the [contribution guide](https://filebrowser.org/contributing).
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
<strong>Made with ❤️ by the File Browser Community</strong>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue