quickshare/README.md
Hexxa b0d1cdccfc
fix(docker): add dockfile and small fixes (#38)
* fix(docker): add dockfile and small fixes

* chore(readme): small fixes
2021-02-01 21:36:56 +08:00

2.5 KiB

Quickshare

Quick and simple file sharing between different devices.

Quickshare on desktop

Quickshare on mobile

Choose Language: English | 简体中文

Main Features

  • Sharing and accessing from different devices (Adaptive UI)
  • Be compatible with Linux, Mac and Windows
  • Stopping and resuming uploading/downloading
  • Do uploading and downloading in web browser
  • Manage files in browser or in OS

Quick Start

Run in Docker

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:0.3.0 
  • DEFAULTADMIN is the default user name
  • DEFAULTADMINPWD is the default user password
  • /quickshare/root is where Quickshare stores files and directories.

Run from source code

Before start, please ensure Go/Golang (>1.15), Node.js and Yarn are installed on your machine.

# clone this repo
git clone git@github.com: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.
  • 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.