https://github.com/chadnpc/fileserver
A file server backend build using Go + Gin
https://github.com/chadnpc/fileserver
Last synced: about 2 hours ago
JSON representation
A file server backend build using Go + Gin
- Host: GitHub
- URL: https://github.com/chadnpc/fileserver
- Owner: chadnpc
- License: gpl-3.0
- Created: 2023-08-18T14:09:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-12T23:01:21.000Z (over 1 year ago)
- Last Synced: 2025-03-17T20:19:30.834Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 941 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
FileServer backend
Self-hosted file management system with muilt-cloud support.
Homepage •
Demo •
Discussion •
Documents •
Download •
Telegram Group •
License
## **Features**
* :cloud: Support storing files into Local storage, Remote storage, Qiniu, Aliyun OSS, Tencent COS, Upyun, OneDrive, S3 compatible API.
* :outbox_tray: Upload/Download in directly transmission with speed limiting support.
* 💾 Integrate with Aria2 to download files offline, use multiple download nodes to share the load.
* 📚 Compress/Extract files, download files in batch.
* 💻 WebDAV support covering all storage providers.
* :zap:Drag&Drop to upload files or folders, with streaming upload processing.
* :card_file_box: Drag & Drop to manage your files.
* :family_woman_girl_boy: Multi-users with multi-groups.
* :link: Create share links for files and folders with expiration date.
* :eye_speech_bubble: Preview videos, images, audios, ePub files online; edit texts, Office documents online.
* :art: Customize theme colors, dark mode, PWA application, SPA, i18n.
* :rocket: All-In-One packing, with all features out-of-the-box.
* 🌈 ... ...
## :hammer_and_wrench: **Deploy**
Download the main binary for your target machine OS, CPU architecture and run it directly.
```shell
# Extract FileServer binary
tar -zxvf FileServer_VERSION_OS_ARCH.tar.gz
# Grant execute permission
chmod +x ./FileServer
# Start FileServer
./FileServer
```
The above is a minimum deploy example, you can refer to [Getting started](https://docs.FileServer.org/v/en/getting-started/install) for a completed deployment.
## :gear: **Build**
You need to have `Go >= 1.18`, `node.js`, `yarn`, `zip`, [goreleaser](https://goreleaser.com/intro/) and other necessary dependencies before you can build it yourself.
#### Install goreleaser
```shell
go install github.com/goreleaser/goreleaser@latest
```
#### Clone the code
```shell
git clone --recurse-submodules https://github.com/alainQtec/FileServer.git
```
#### Compile
```shell
goreleaser build --clean --single-target --snapshot
```
## :alembic: Stacks
* [Go](https://golang.org/) + [Gin](https://github.com/gin-gonic/gin)
* [React](https://github.com/facebook/react) + [Redux](https://github.com/reduxjs/redux) + [Material-UI](https://github.com/mui-org/material-ui)
## **Contributing**
Contributions are welcome! If you find any bugs or have suggestions for improvements, feel free to open an issue or submit a pull request.
## **License**
This project is licensed under the GPLv3 License.