filebrowser/README.md
2025-01-24 20:35:23 +12:00

71 lines
2.8 KiB
Markdown

<div align="center">
<img src="https://raw.githubusercontent.com/filebrowser/logo/master/banner.png" width="550" alt="File Browser Banner" />
</div>
---
<div align="center">
<img src="https://user-images.githubusercontent.com/5447088/50716739-ebd26700-107a-11e9-9817-14230c53efd2.gif" alt="File Browser Preview" />
</div>
---
<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>
---
# File Browser
**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.
---
## 🛠️ Features
Explore all the features in the [official documentation](https://filebrowser.org/features).
---
## 🚀 Demo
- **URL**: [https://demo.filebrowser.org/](https://demo.filebrowser.org/)
- **Credentials**: `demo` / `demo`
---
## 📥 Installation
Follow the installation guide at [https://filebrowser.org/installation](https://filebrowser.org/installation).
---
## ⚙️ 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.
---
## 🤝 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>