From 61e3a95df960ab6bf9c3db037cbcd4bf5620cb52 Mon Sep 17 00:00:00 2001 From: lan Date: Sat, 15 Jun 2024 21:40:56 +0800 Subject: [PATCH] update: readme.md --- readme.md | 99 +++++++++----------- readme_en.md | 255 ++++++++++++++++++++------------------------------- 2 files changed, 144 insertions(+), 210 deletions(-) diff --git a/readme.md b/readme.md index 05303bc..5e588a7 100644 --- a/readme.md +++ b/readme.md @@ -13,30 +13,33 @@ ## 主要特色 -- [x] 轻量简洁：Fastapi+Sqlite3+Vue2+ElementUI -- [x] 轻松上传：复制粘贴，拖拽选择 -- [x] 多种类型：文本，文件 -- [x] 防止爆破：错误次数限制 -- [x] 防止滥用：IP限制上传次数 -- [x] 口令分享：随机口令，存取文件，自定义次数以及有效期 -- [x] 国际化：支持中文和英文 -- [x] 匿名分享：无需注册，无需登录 -- [x] 管理面板：查看所有文件，删除文件 -- [x] 一键部署：docker一键部署 -- [x] 自由拓展：S3协议、本地文件流，可根据需求在storage文件中新增存储引擎 -- [x] 简单明了：适合新手练手项目 -- [x] 终端下载：wget https://share.lanol.cn/share/select?code=83432 +- [x] **轻量简洁：** 使用Fastapi + Sqlite3 + Vue2 + ElementUI搭建 +- [x] **轻松上传：** 支持复制粘贴和拖拽选择 +- [x] **多种类型：** 支持文本和文件 +- [x] **防止爆破：** 错误次数限制 +- [x] **防止滥用：** IP限制上传次数 +- [x] **口令分享：** 随机口令，存取文件，自定义次数及有效期 +- [x] **国际化：** 支持中文和英文 +- [x] **匿名分享：** 无需注册，无需登录 +- [x] **管理面板：** 查看和删除文件 +- [x] **一键部署：** 支持Docker一键部署 +- [x] **自由拓展：** 支持S3协议和本地文件流，可根据需求在storage文件中新增存储引擎 +- [x] **简单明了：** 适合新手练手项目 +- [x] **终端下载：** 终端命令`wget https://share.lanol.cn/share/select?code=83432` ## 部署方式 ### 1Panel一键部署 -应用商店->实用工具->FileCodeBox +进入应用商店 -> 实用工具 -> FileCodeBox ![img_6.png](./.github/images/img_6.png) -更新：容器->选择->更多->编辑->强制拉取镜像->确认 +**更新：** 容器 -> 选择 -> 更多 -> 编辑 -> 强制拉取镜像 -> 确认 + ### 宝塔应用商店一键部署 -貌似是1.6版本的 + +目前版本为1.6 ![img](https://img.065065.xyz/file/966c5239926f46e03bd91.png) + ### Docker一键部署 #### 2.0版本，完善中 @@ -47,16 +50,15 @@ 后台密码：`FileCodeBox2023` -AMD & ARM +*支持AMD & ARM* -一键安装 +**一键安装** ```bash docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta - ``` -一键更新 +**一键更新** ```bash docker pull lanol/filecodebox:beta && docker stop filecodebox && docker rm filecodebox && docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta @@ -77,25 +79,24 @@ docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --n ### 更新方式 ```bash -// 更新 +// 更新容器 docker pull lanol/filecodebox:beta -// 停止容器并删除 +// 停止和删除容器 docker stop filecodebox && docker rm filecodebox // 重新运行容器 docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest ``` -### 1.6版本注意 +#### 1.6版本注意事项 -这一版改变比较大，如果出现问题可以尝试清空/opt/FileCodeBox目录，有问题欢迎反馈留言 -注意，如果是第一次安装，请查看docker日志获取初始密码和后台地址，参考指令 -后台本地文件列表，需要将服务器文件移动至目录/opt/FileCodeBox/data/locals，这样就可以显示了。 +本版变动较大，如遇问题可尝试清空/opt/FileCodeBox目录，有问题欢迎反馈。**注意：** 如为首次安装，请查看Docker日志以获取初始密码和后台地址，参考命令如下： ```bash docker logs filecodebox - ``` +**后台本地文件列表**：需要将服务器文件移动至/opt/FileCodeBox/data/locals目录，这样才会显示。 + ## 预览 ### 例站 @@ -106,35 +107,23 @@ docker logs filecodebox - - + + - - + + - - + +
-寄文件 - -寄文件 -寄文件寄文件
-寄文件 - -寄文件 -寄文件寄文件
-寄文件 - -寄文件 -寄文件寄文件
-## 配置文件（1.7及以下版本才需要） +## 配置文件（适用于1.7及以下版本） -如果需要修改配置，可以将该文件放在`/opt/FileCodeBox/`目录下，并命名为`.env`，然后重启容器即可。 -如果不是Docker，则需要在项目同目录下新建一个`data`文件夹，然后在创建`.env`文件 +需要修改配置时，将以下内容保存为`.env`文件放置在`/opt/FileCodeBox/`目录下，重启容器即可。 +若未使用Docker，则需在项目同目录下创建一个`data`文件夹，并在该文件夹内创建`.env`文件。 ```dotenv # 端口 @@ -171,7 +160,7 @@ DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享 KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 # 存储引擎 STORAGE_ENGINE=filesystem -# 如果使用阿里云OSS服务的话需要额外创建如下参数： +# 如果使用阿里云OSS服务需额外创建如下参数： # 阿里云账号AccessKey KeyId=阿里云账号AccessKey # 阿里云账号AccessKeySecret @@ -182,7 +171,7 @@ OSS_ENDPOINT=阿里云OSS Bucket的地域节点 BUCKET_NAME=阿里云OSS Bucket的BucketName ``` -## 状态 +## 项目状态 ![Alt](https://repobeats.axiom.co/api/embed/7a6c92f1d96ee57e6fb67f0df371528397b0c9ac.svg "Repobeats analytics image") @@ -192,12 +181,10 @@ BUCKET_NAME=阿里云OSS Bucket的BucketName ## 常见问题 -1. 413 Request Entity Too Large - Nginx限制： - 找到自己主机的nginx.conf配置文件，打开 - 在http{}中加入 client_max_body_size 10m; - 然后重启nginx +1. *413 Request Entity Too Large*: + Nginx限制解决方法： + 打开主机的`nginx.conf`配置文件，在`http{}`中加入`client_max_body_size 10m;`，然后重启Nginx。 ## 免责声明 -本项目开源仅供学习使用，不得用于任何违法用途，否则后果自负，与本人无关。使用请保留项目地址谢谢。 +本项目开源仅供学习使用，不得用于任何违法用途，否则后果自负，与本人无关。使用请保留项目地址，谢谢。 \ No newline at end of file diff --git a/readme_en.md b/readme_en.md index 24afebf..6e6fdc0 100644 --- a/readme_en.md +++ b/readme_en.md @@ -1,8 +1,8 @@
-

File Express Cabinet - Lite

+

FileCodeBox-Lite

FileCodeBox-Lite

-

Anonymously share text and files, retrieve files like receiving packages

-

Communication Q group: 739673698, welcome everyone to brainstorm, project conceptual reconstruction

+

Share texts and files anonymously with passwords, just like picking up a package

+

Join our QQ group: 739673698

![banner](https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png) @@ -13,198 +13,161 @@ ## Main Features -- [x] Lightweight and concise: Fastapi+Sqlite3+Vue3+ElementUI -- [x] Easy upload: Copy and paste, drag and drop selection -- [x] Multiple types: Text, file -- [x] Prevent brute force: Limit the number of errors -- [x] Prevent abuse: Limit the number of uploads by IP -- [x] Password sharing: Random password, store and retrieve files, customize the number of times and validity period -- [x] Anonymous sharing: No registration, no login, no IP records -- [x] Management panel: View all files, delete files -- [x] One-click deployment: Docker one-click deployment -- [x] Free extension: S3 protocol, local file stream, can add storage engines in the storage file according to needs -- [x] Simple and clear: Suitable for beginners' practice projects +- [x] **Lightweight:** Built with FastAPI + Sqlite3 + Vue2 + ElementUI +- [x] **Easy Upload:** Support copy-paste and drag-and-drop selection +- [x] **Various Types:** Supports text and file sharing +- [x] **Brute-force Protection:** Error limit on passwords +- [x] **Abuse Prevention:** IP limits on upload attempts +- [x] **Password Sharing:** Random password for accessing files, customizable access counts, and expiration +- [x] **Internationalization:** Supports both Chinese and English +- [x] **Anonymous Sharing:** No need for registration or login +- [x] **Management Panel:** View and delete files +- [x] **One-Click Deployment:** Support for Docker deployment +- [x] **Free Extension:** Supports S3 protocol and local file stream; can add new storage engines in storage file as needed +- [x] **Simple and Clear:** Great for beginners +- [x] **Terminal Download:** Terminal command `wget https://share.lanol.cn/share/select?code=83432` -## Deployment Method +## Deployment Methods -### Docker one-click deployment +### 1Panel One-Click Deployment -#### Version 2.0, under development +Go to Application Store -> Utilities -> FileCodeBox +![img_6.png](./.github/images/img_6.png) +**Update:** Container -> Select -> More -> Edit -> Force Pull Image -> Confirm -Default information +### One-Click Deployment in BaoTa Application Store -Backend address: `/#/admin` +Current version is 1.6 +![img](https://img.065065.xyz/file/966c5239926f46e03bd91.png) -Backend password: `FileCodeBox2023` +### Docker One-Click Deployment -AMD & ARM +**Version 2.0**, work in progress -One-click installation +Default Info + +Backend Address: `/#/admin` + +Admin Password: `FileCodeBox2023` + +*Supports AMD & ARM* + +**One-Click Install** ```bash docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta - ``` -One-click update +**One-Click Update** ```bash docker pull lanol/filecodebox:beta && docker stop filecodebox && docker rm filecodebox && docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:beta ``` -#### Version 1.6 AMD +**Version 1.6 AMD** ```bash docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest ``` -#### Version 1.6 ARM +**Version 1.6 ARM** ```bash docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:arm ``` -### Baota deployment +### Update Methods -Not recommended, outdated -https://www.yuque.com/lxyo/work/lc1oe0xqk8t9b976 +```bash +// Update the container +docker pull lanol/filecodebox:beta +// Stop and remove the container +docker stop filecodebox && docker rm filecodebox +// Re-run the container +docker run -d --restart=always -p 12345:12345 -v /opt/FileCodeBox/:/app/data --name filecodebox lanol/filecodebox:latest +``` -### Version 1.6 Note +### Notes on Version 1.6 -This version has relatively large changes. If there are any problems, you can try clearing the /opt/FileCodeBox directory. If you have any problems, please feel free to leave -feedback. -Note that if this is the first installation, please check the docker log to get the initial password and backend address, and refer to the instructions -For the local file list of the background, you need to move the server files to the directory /opt/FileCodeBox/data/locals so that they can be displayed. +This version has significant changes. If issues occur, try clearing the /opt/FileCodeBox directory. Feel free to provide feedback. **Note:** For first-time installations, check Docker logs for the initial password and backend address, as shown below: ```bash docker logs filecodebox ``` +**Backend Local File List**: Move server files to the /opt/FileCodeBox/data/locals directory for display. + ## Preview -### Example site +### Example Site [https://share.lanol.cn](https://share.lanol.cn) -### Dark mode +### Screenshots - - - + + + + + + + + + +
-Send files - - -Send files - -File SharingFile Sharing
File SharingFile Sharing
File SharingFile Sharing
-### Sending +## Configuration File (for versions 1.7 and below) - - - - - - - - -
-Send files - -Send text -
-Send text -
- -### Retrieving - - - - - - - - - -
-Retrieve - -Wrong retrieval code -
-Retrieve file -
- -### Management - - - - - - - - - -
-admin - -admin -
-admin -
- -## Configuration file (only required for version 1.7 and below) - -If you need to modify the configuration, you can place this file in the `/opt/FileCodeBox/` directory and name it `.env`, then restart the container. -If it is not Docker, you need to create a `data` folder in the same directory as the project, and then create a `.env` file. +To modify the configuration, save the following content as a `.env` file in the `/opt/FileCodeBox/` directory, then restart the container. If not using Docker, create a `data` folder in the project directory and place the `.env` file inside. ```dotenv -# 端口 +# Port PORT=12345 -# Sqlite数据库文件 +# Sqlite database file DATABASE_URL=sqlite+aiosqlite:///database.db -# 静态文件夹 +# Static folder DATA_ROOT=./static -# 静态文件夹URL +# Static folder URL STATIC_URL=/static -# 开启上传 +# Enable uploads ENABLE_UPLOAD=True -# 错误次数 +# Error limit ERROR_COUNT=5 -# 错误限制分钟数 +# Error limit in minutes ERROR_MINUTE=10 -# 上传次数 +# Upload limit UPLOAD_COUNT=60 -# 上传限制分钟数 +# Upload limit in minutes UPLOAD_MINUTE=1 -# 删除过期文件的间隔（分钟） +# Interval for deleting expired files (in minutes) DELETE_EXPIRE_FILES_INTERVAL=10 -# 管理地址 +# Admin address ADMIN_ADDRESS=admin -# 管理密码 +# Admin password ADMIN_PASSWORD=admin -# 文件大小限制，默认10MB +# File size limit, default 10MB FILE_SIZE_LIMIT=10 -# 网站标题 -TITLE=文件快递柜 -# 网站描述 -DESCRIPTION=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 -# 网站关键词 -KEYWORDS=FileCodeBox，文件快递柜，口令传送箱，匿名口令分享文本，文件，图片，视频，音频，压缩包等文件 -# 存储引擎 +# Website title +TITLE=FileCodeBox +# Website description +DESCRIPTION=FileCodeBox, file delivery cabinet, password transfer box, anonymous password sharing of text, files, images, videos, audio, compressed files, and other types of files +# Website keywords +KEYWORDS=FileCodeBox, file delivery cabinet, password transfer box, anonymous password sharing of text, files, images, videos, audio, compressed files, and other types of files +# Storage engine STORAGE_ENGINE=filesystem -# 如果使用阿里云OSS服务的话需要额外创建如下参数： -# 阿里云账号AccessKey -KeyId=阿里云账号AccessKey -# 阿里云账号AccessKeySecret -KeySecret=阿里云账号AccessKeySecret -# 阿里云OSS Bucket的地域节点 -OSS_ENDPOINT=阿里云OSS Bucket的地域节点 -# 阿里云OSS Bucket的BucketName -BUCKET_NAME=阿里云OSS Bucket的BucketName +# If using Alibaba Cloud OSS service, create these additional parameters: +# Alibaba Cloud Account AccessKey +KeyId=Alibaba Cloud Account AccessKey +# Alibaba Cloud Account AccessKeySecret +KeySecret=Alibaba Cloud Account AccessKeySecret +# Alibaba Cloud OSS Bucket region node +OSS_ENDPOINT=Alibaba Cloud OSS Bucket region node +# Alibaba Cloud OSS Bucket name +BUCKET_NAME=Alibaba Cloud OSS Bucket name ``` ## Status @@ -215,30 +178,14 @@ BUCKET_NAME=阿里云OSS Bucket的BucketName [![Star History Chart](https://api.star-history.com/svg?repos=vastsa/FileCodeBox&type=Date)](https://star-history.com/#vastsa/FileCodeBox&Date) -## Appreciation +## Frequently Asked Questions (FAQ) - - - - - -
-Alipay -Alipay - -WeChat -WeChat -
- -## Frequently Asked Questions - -1. 413 Request Entity Too Large - Nginx restriction: - Find the nginx.conf configuration file of your host and open it. - Add `client_max_body_size 10m;` inside the `http{}` block. - Then restart nginx. +1. *413 Request Entity Too Large*: + Nginx limit resolution: + Open your host's `nginx.conf` configuration file, locate it, + Add `client_max_body_size 10m;` within the `http{}` block, + Then restart Nginx. ## Disclaimer -This project is open source and is intended for learning purposes only. It must not be used for any illegal purposes. Any consequences arising from such use are the sole -responsibility of the user and are not related to me. Please keep the project address when using. Thank you. +This project is open-source and intended for learning purposes only. Do not use it for any illegal activities; any consequences are your own responsibility and unrelated to the author. Please retain the project address when using, thank you. \ No newline at end of file