79 lines
2.4 KiB
Markdown
79 lines
2.4 KiB
Markdown
<h1 align="center">
|
|
Quickshare
|
|
</h1>
|
|
<p align="center">
|
|
简单的文件共享服务, 使用Go/Golang, Typescript, Gin, React, Boltdb等构建.
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/ihexxa/quickshare/actions">
|
|
<img src="https://github.com/ihexxa/quickshare/workflows/quickshare-ci/badge.svg" />
|
|
</a>
|
|
<a href="https://goreportcard.com/report/github.com/ihexxa/quickshare">
|
|
<img src="https://goreportcard.com/badge/github.com/ihexxa/quickshare" />
|
|
</a>
|
|
<a href="https://gitter.im/quickshare/Lobby?utm_source=share-link&utm_medium=link&utm_campaign=share-link">
|
|
<img src="https://badges.gitter.im/Join%20Chat.svg" />
|
|
</a>
|
|
<p>
|
|
|
|
|
|
|
|
|
|
|
|
选择语言: [English](../README.md) | 简体中文
|
|
|
|
## 主要功能
|
|
|
|
- 在多个设备之间共享和存取文件 (自适应 UI)
|
|
- 兼容 Linux, Mac 和 Windows
|
|
- 上传下载都支持断点续传
|
|
- 在 Web 浏览器 中完成上传下载
|
|
- 通过浏览器或者OS管理文件
|
|
|
|
## 快速开始
|
|
|
|
### 在Docker内运行
|
|
|
|
下面会启动一个 `quickshare` docker 并监听 `8686` 端口.
|
|
|
|
然后你可以打开 `http://127.0.0.1:8686` 并且使用用户名 `qs` 和 密码 `1234` 登入.
|
|
|
|
```
|
|
docker run \
|
|
--name quickshare \
|
|
-d -p 8686:8686 \
|
|
-v `pwd`/quickshare/root:/quickshare/root \
|
|
-e DEFAULTADMIN=qs \
|
|
-e DEFAULTADMINPWD=1234 \
|
|
hexxa/quickshare
|
|
```
|
|
|
|
- `DEFAULTADMIN` 是默认的用户名
|
|
- `DEFAULTADMINPWD` 是默认的用户密码
|
|
- `/quickshare/root` 是 Quickshare 保存文件和目录的地方.
|
|
|
|
### 运行源代码
|
|
|
|
在开始之前, 请确认 Go/Golang (>1.15), Node.js 和 Yarn 已经安装在您的机器.
|
|
|
|
```
|
|
# 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! 在浏览器中打开 `http://127.0.0.1:8686`, 并且使用用户名 `qs` 和 密码 `1234` 登入.
|
|
|
|
### 运行可执行文件
|
|
|
|
- **下载**: 下载最新的可执行文件 [Release Page](https://github.com/ihexxa/quickshare/releases).
|
|
- **解压**: 解压并执行 `DEFAULTADMIN=qs DEFAULTADMINPWD=1234 ./quickshare`. (你可能需要更新它的执行权限, 比如运行 `chmod u+x quickshare`)
|
|
- **访问**: 最后, 打开 `http://127.0.0.1:8686`, 并且使用用户名 `qs` 和 密码 `1234` 登入.
|
|
|
|
### 常见问题
|
|
|
|
Coming soon.
|