From 65ad220bb4c62ea64053cc317627b96f3bb3f7cb Mon Sep 17 00:00:00 2001 From: lan Date: Wed, 14 Dec 2022 00:16:12 +0800 Subject: [PATCH] update:readme --- readme.md | 54 ++++++++++++++++++++++++ readme_en.md | 115 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 169 insertions(+) create mode 100644 readme_en.md diff --git a/readme.md b/readme.md index 2c6041c..fc5771a 100644 --- a/readme.md +++ b/readme.md @@ -5,6 +5,8 @@ --- +[简体中文](./readme.md) | [English](./readme_en.md) + ## 主要特色 - [x] 轻量简洁：Fastapi+Sqlite3+Vue2+ElementUI @@ -56,4 +58,56 @@ ### 管理 + ![管理](https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_7.png) + +## 部署方式 + +### Docker一键部署 + +```bash +docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest +``` + +### 其他方式 + +请参考->[部署文档](https://www.yuque.com/lxyo/work/zd0kvzy7fofx6w7v) + +## 配置文件 + +如果需要修改配置，可以将该文件放在`/opt/FileCodeBox/`目录下，并命名为`.env`，然后重启容器即可。 + +```bash + +```dotenv +# 端口 +PORT=12345 +# Sqlite数据库文件 +DATABASE_URL=sqlite+aiosqlite:///database.db +# 静态文件夹 +DATA_ROOT=./static +# 静态文件夹URL +STATIC_URL=/static +# 错误次数 +ERROR_COUNT=5 +# 错误限制分钟数 +ERROR_MINUTE=10 +# 上传次数 +UPLOAD_COUNT=60 +# 上传限制分钟数 +UPLOAD_MINUTE=1 +# 管理地址 +ADMIN_ADDRESS=admin +# 管理密码 +ADMIN_PASSWORD=admin +# 文件大小限制，默认10MB +FILE_SIZE_LIMIT=10 +# 网站标题 +TITLE=文件快递柜 +# 网站描述 +DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 +# 网站关键词 +KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 +# 存储引擎 +STORAGE_ENGINE=filesystem +``` diff --git a/readme_en.md b/readme_en.md new file mode 100644 index 0000000..606d80d --- /dev/null +++ b/readme_en.md @@ -0,0 +1,115 @@ +
+

File Express Cabinet

+

share text and files with anonymous passwords, and take files like express delivery

+
+ +--- + +[English](./README_EN.md) | [简体中文](./README.md) + +## Main features + +- [x] lightweight and simple: Fastapi + Sqlite3 + Vue2 + ElementUI +- [x] easy upload: copy and paste, drag and drop +- [x] multiple types: Text, File +- [x] explosion Prevention: error count limit +- [x] prevent abuse: IP address limits the number of uploads +- [x] password sharing: random password, file access, custom times, and validity period +- [x] anonymous sharing: no registration, no login +- [x] management Panel: View all files and delete them +- [x] one-click deployment: docker one-click deployment + +## Preview + +### Send + + + + + + + + + +
+寄文件 + +寄文本 +
+寄文本 +
+ +### Receive + + + + + + + + + +
+取件 + +取件码错误 +
+取文件 +
+ +### Manage + +![管理](https://raw.githubusercontent.com/vastsa/FileCodeBox/master/images/img_7.png) + +## Deployment method + +### One-click Docker deployment + +```bash +docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest +``` + +### Other methods + +请参考->[部署文档](https://www.yuque.com/lxyo/work/zd0kvzy7fofx6w7v) + +## Configuration file + +if you need to modify the configuration, you can put the file in `/opt/FileCodeBox/` directory and name it `.env` , and +then +restart the container. + +```bash + +```dotenv +# 端口 +PORT=12345 +# Sqlite数据库文件 +DATABASE_URL=sqlite+aiosqlite:///database.db +# 静态文件夹 +DATA_ROOT=./static +# 静态文件夹URL +STATIC_URL=/static +# 错误次数 +ERROR_COUNT=5 +# 错误限制分钟数 +ERROR_MINUTE=10 +# 上传次数 +UPLOAD_COUNT=60 +# 上传限制分钟数 +UPLOAD_MINUTE=1 +# 管理地址 +ADMIN_ADDRESS=admin +# 管理密码 +ADMIN_PASSWORD=admin +# 文件大小限制，默认10MB +FILE_SIZE_LIMIT=10 +# 网站标题 +TITLE=文件快递柜 +# 网站描述 +DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 +# 网站关键词 +KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 +# 存储引擎 +STORAGE_ENGINE=filesystem +```