94 lines
3.1 KiB
Markdown
94 lines
3.1 KiB
Markdown
<h1 align="center">
|
||
Quickshare
|
||
</h1>
|
||
<p align="center">
|
||
简单的文件共享服务, 使用Go/Golang, Typescript, Gin, React, Boltdb等构建.
|
||
(<a href="https://github.com/ihexxa/quickshare/blob/main/docs/screenshots.md">界面截图</a>)
|
||
</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>
|
||
<p>
|
||
|
||
<image src="./imgs/v0.9.1/quickshare_1920.gif" title="preview">
|
||
|
||
[English](../README.md) | 简体中文
|
||
|
||
> Quickshare 仍然活跃开发中, 请意识到目前每个版本并不保证向前兼容.
|
||
|
||
## 主要功能
|
||
|
||
- 文件管理
|
||
- 支持上传，下载，创建，删除和移动文件和文件夹
|
||
- 可恢复的上传和下载（断点续传）
|
||
- 在浏览器中管理文件和文件夹
|
||
- 多关键字的文件与目录查找，在几秒内返回结果
|
||
- 将目录共享他人，包括未登录用户
|
||
- 通过扫一扫访问共享文件夹/网站
|
||
- 一次上传上百个文件
|
||
- 流式上传: 使它可工作在 CDN 或 反向代理 之后
|
||
- 也可通过操作系统管理文件
|
||
- 用户管理
|
||
- 支持多用户
|
||
- 每个用户有个各自角色（user/admin）
|
||
- 用户 home 目录
|
||
- 用户级别的上传下载速度限制
|
||
- 用户级别的空间限制
|
||
- 其他
|
||
- 自适应 UI
|
||
- 多语言支持
|
||
- 自定义壁纸支持
|
||
- 跨平台: 支持 Linux, Mac and Windows
|
||
|
||
## 快速开始
|
||
|
||
### 通过 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 保存文件和目录的地方
|
||
- 如果你想同时在操作系统管理文件和文件夹，请参考 [这个文档](./docs/doc.md)
|
||
|
||
### 运行源代码
|
||
|
||
在开始之前, 请确认 Go/Golang (>=1.17), 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.
|