QuickShare
<h1 align="center"> Quickshare </h1> <p align="center"> Quick and simple file sharing between different devices. ( <a href="https://github.com/ihexxa/quickshare/blob/main/docs/screenshots.md">Screenshots</a> | <a href="https://github.com/ihexxa/quickshare/blob/main/docs/imgs/v0.9.1/quickshare_1920.gif">Demo</a> ) </p> <p align="center"> <a href="https://github.com/ihexxa/quickshare/actions"> <img src="https://github.com/ihexxa/quickshare/actions/workflows/ci_build.yml/badge.svg" /> </a> <a href="https://github.com/ihexxa/quickshare/actions"> <img src="https://github.com/ihexxa/quickshare/actions/workflows/cd_docker.yml/badge.svg" /> </a> <a href="https://github.com/ihexxa/quickshare/actions"> <img src="https://github.com/ihexxa/quickshare/actions/workflows/cd_github_binary.yml/badge.svg" /> </a> <a href="https://goreportcard.com/report/github.com/ihexxa/quickshare"> <img src="https://goreportcard.com/badge/github.com/ihexxa/quickshare" /> </a> <p> <image src="./docs/imgs/v0.11.0/screenshot.png" title="preview"> English | [简体中文](./docs/README_zh-cn.md) > Quickshare is still under active development, please keep in mind that full backward compatibility is not guaranteed. ## Features - File Management - Support uploading, downloading, creating, deleting and moving files and folders - Support fuzzy searching files and folders in seconds - Resumable uploading and downloading - Manage files and folders in browser - Share directories to others, including anonymous - Scan QR codes to visit sharing folders - Upload hundreds of files at once - Steaming uploading: make it work behind CDN or reverse proxy - Files can also be managed from OS - User Management - Support multiple users - Each user has a role (user/admin) - User home directory - Per-user download & upload speed limiting - Per-user space quota - MISC - Adaptive UI - I18n support - Wallpaper customization - Cross-platform: support Linux, Mac and Windows ## Quick Start ### Run in Docker (Recommended) Following will start a `quickshare` docker and listen to `8686` port. Then you can open `http://127.0.0.1:8686` and log in with user name `qs` and password `1234`: ``` docker run \ --name quickshare \ -d -p 8686:8686 \ -v `pwd`/quickshare/root:/quickshare/root \ -e DEFAULTADMIN=qs \ -e DEFAULTADMINPWD=1234 \ hexxa/quickshare ``` - `DEFAULTADMIN` is the default user name - `DEFAULTADMINPWD` is the default user password - `/quickshare/root` is where the Quickshare stores files and directories. - Please refer to [this doc](./docs/doc.md) if you want to manage files and folders from OS. ### Run from source code Before start, please confirm that Go/Golang (>=1.17), Node.js and Yarn are installed on your machine. ``` # clone this repo git clone [email protected]:ihexxa/quickshare.git # go to repo's folder cd quickshare DEFAULTADMIN=qs DEFAULTADMINPWD=1234 yarn start ``` OK! Open `http://127.0.0.1:8686` in browser, and log in with user name `qs` and password `1234`. ### Run executable file - **Downloading**: Download last distribution(s) in [Release Page](https://github.com/ihexxa/quickshare/releases). - **Unzipping**: Unzip it and run following command `DEFAULTADMIN=qs DEFAULTADMINPWD=1234 ./quickshare`. (You may update its execution permission: e.g. run `chmod u+x quickshare`) - **Accessing**: At last, open `http://127.0.0.1:8686` in browser, and log in with user name `qs` and password `1234`. ### FAQ Coming soon.