Skip to content

Commit 65ad220

Browse files
vastsavastsa
committed
update:readme
1 parent 585bf09 commit 65ad220

File tree

2 files changed

+169
-0
lines changed

2 files changed

+169
-0
lines changed

‎readme.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
---
77

8+
[简体中文](./readme.md) | [English](./readme_en.md)
9+
810
## 主要特色
911

1012
- [x] 轻量简洁：Fastapi+Sqlite3+Vue2+ElementUI
@@ -56,4 +58,56 @@
5658
</table>
5759

5860
### 管理
61+
5962
![管理](https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_7.png)
63+
64+
## 部署方式
65+
66+
### Docker一键部署
67+
68+
```bash
69+
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest
70+
```
71+
72+
### 其他方式
73+
74+
请参考->[部署文档](https://www.yuque.com/lxyo/work/zd0kvzy7fofx6w7v)
75+
76+
## 配置文件
77+
78+
如果需要修改配置，可以将该文件放在`/opt/FileCodeBox/`目录下，并命名为`.env`，然后重启容器即可。
79+
80+
```bash
81+
82+
```dotenv
83+
# 端口
84+
PORT=12345
85+
# Sqlite数据库文件
86+
DATABASE_URL=sqlite+aiosqlite:///database.db
87+
# 静态文件夹
88+
DATA_ROOT=./static
89+
# 静态文件夹URL
90+
STATIC_URL=/static
91+
# 错误次数
92+
ERROR_COUNT=5
93+
# 错误限制分钟数
94+
ERROR_MINUTE=10
95+
# 上传次数
96+
UPLOAD_COUNT=60
97+
# 上传限制分钟数
98+
UPLOAD_MINUTE=1
99+
# 管理地址
100+
ADMIN_ADDRESS=admin
101+
# 管理密码
102+
ADMIN_PASSWORD=admin
103+
# 文件大小限制，默认10MB
104+
FILE_SIZE_LIMIT=10
105+
# 网站标题
106+
TITLE=文件快递柜
107+
# 网站描述
108+
DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件
109+
# 网站关键词
110+
KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件
111+
# 存储引擎
112+
STORAGE_ENGINE=filesystem
113+
```

‎readme_en.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
<div style="text-align: center">
2+
<h1>File Express Cabinet </h1>
3+
<p><em>share text and files with anonymous passwords, and take files like express delivery </em></p>
4+
</div>
5+
6+
---
7+
8+
[English](./README_EN.md) | [简体中文](./README.md)
9+
10+
## Main features
11+
12+
- [x] lightweight and simple: Fastapi + Sqlite3 + Vue2 + ElementUI
13+
- [x] easy upload: copy and paste, drag and drop
14+
- [x] multiple types: Text, File
15+
- [x] explosion Prevention: error count limit
16+
- [x] prevent abuse: IP address limits the number of uploads
17+
- [x] password sharing: random password, file access, custom times, and validity period
18+
- [x] anonymous sharing: no registration, no login
19+
- [x] management Panel: View all files and delete them
20+
- [x] one-click deployment: docker one-click deployment
21+
22+
## Preview
23+
24+
### Send
25+
26+
<table style="width: 100%">
27+
<tr style="width: 100%">
28+
<td style="width: 50%">
29+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_1.png" alt="寄文件">
30+
</td>
31+
<td style="width: 50%">
32+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_2.png" alt="寄文本">
33+
</td>
34+
</tr>
35+
<tr style="width: 100%;">
36+
<td colspan="2" style="width: 100%;">
37+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_3.png" alt="寄文本">
38+
</td>
39+
</tr>
40+
</table>
41+
42+
### Receive
43+
44+
<table style="width: 100%">
45+
<tr style="width: 100%">
46+
<td style="width: 50%">
47+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_6.png" alt="取件">
48+
</td>
49+
<td style="width: 50%">
50+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_5.png" alt="取件码错误">
51+
</td>
52+
</tr>
53+
<tr style="width: 100%;">
54+
<td colspan="2" style="width: 100%;">
55+
<img src="https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_4.png" alt="取文件">
56+
</td>
57+
</tr>
58+
</table>
59+
60+
### Manage
61+
62+
![管理](https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_7.png)
63+
64+
## Deployment method
65+
66+
### One-click Docker deployment
67+
68+
```bash
69+
docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest
70+
```
71+
72+
### Other methods
73+
74+
请参考->[部署文档](https://www.yuque.com/lxyo/work/zd0kvzy7fofx6w7v)
75+
76+
## Configuration file
77+
78+
if you need to modify the configuration, you can put the file in `/opt/FileCodeBox/` directory and name it `.env` , and
79+
then
80+
restart the container.
81+
82+
```bash
83+
84+
```dotenv
85+
# 端口
86+
PORT=12345
87+
# Sqlite数据库文件
88+
DATABASE_URL=sqlite+aiosqlite:///database.db
89+
# 静态文件夹
90+
DATA_ROOT=./static
91+
# 静态文件夹URL
92+
STATIC_URL=/static
93+
# 错误次数
94+
ERROR_COUNT=5
95+
# 错误限制分钟数
96+
ERROR_MINUTE=10
97+
# 上传次数
98+
UPLOAD_COUNT=60
99+
# 上传限制分钟数
100+
UPLOAD_MINUTE=1
101+
# 管理地址
102+
ADMIN_ADDRESS=admin
103+
# 管理密码
104+
ADMIN_PASSWORD=admin
105+
# 文件大小限制，默认10MB
106+
FILE_SIZE_LIMIT=10
107+
# 网站标题
108+
TITLE=文件快递柜
109+
# 网站描述
110+
DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件
111+
# 网站关键词
112+
KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件
113+
# 存储引擎
114+
STORAGE_ENGINE=filesystem
115+
```

0 commit comments

Comments
 (0)