Compare commits

...
12 Commits
Author SHA1 Message Date
github-actions[bot] 6c76aabe1e chore(master): release 2.5.6 (#509)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-09-01 16:08:44 +00:00
vastsa e08555a6e8 Merge fix/prod-log-noise-20260901 2026-09-01 23:56:25 +08:00
vastsa 5537f56b88 fix(logging): reduce production log noise 2026-09-01 23:56:08 +08:00
github-actions[bot] 00f1f1d8da chore(master): release 2.5.5 (#507)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-08-29 04:44:30 +00:00
Lan 5a7195c5c7 Merge pull request #506 from vastsa/fix/pr505-hardened
fix: harden chunk upload filename metadata
2026-08-29 12:44:06 +08:00
vastsa da1dd06655 fix(chunk-upload): persist sanitized filenames 2026-08-29 12:38:46 +08:00
vastsa d510aa7f57 Merge remote-tracking branch 'contributor/pr505' into fix/pr505-hardened 2026-08-29 12:32:00 +08:00
zhou-kkk cebac32145 fix: sanitize chunk upload file_name to prevent path traversal 2026-08-29 12:13:39 +08:00
vastsa f76d1e9841 docs: refresh readme and docs screenshots
Replace legacy PNG assets with new WebP banners and UI captures, and point Chinese/English readme plus docs pages at the updated images.
2026-07-24 16:34:24 +08:00
github-actions[bot] 287b647da1 chore(master): release 2.5.4 (#501)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2026-07-23 14:35:42 +00:00
Lan fbcd4a5b2b Merge pull request #500 from vastsa/fix/docker-run-as-root
fix: run Docker as root for volume compatibility
2026-07-23 22:35:20 +08:00
vastsa fc0cbeb4f0 fix: run Docker image as root for data volume compatibility
Revert the non-root container user so existing deployments with
root-owned data volumes keep working without a manual chown step.
2026-07-23 22:35:00 +08:00
67 changed files with 533 additions and 89 deletions

No files matched your search

Binary file not shown.

Before

Width:  |  Height:  |  Size: 571 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 557 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 205 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 679 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 684 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 411 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 431 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 579 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 200 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 514 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 674 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 678 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 219 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 240 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 233 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 171 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

+1 -1
View File
@@ -1,3 +1,3 @@
{
".": "2.5.3"
".": "2.5.6"
}
+5 -10
View File
@@ -63,20 +63,15 @@ RUN apt-get update \
&& apt-get upgrade -y --no-install-recommends \
&& rm -rf /var/lib/apt/lists/* \
&& pip install --no-cache-dir -r requirements.txt \
&& pip cache purge || true \
&& groupadd --system --gid 1000 appuser \
&& useradd --system --uid 1000 --gid appuser --create-home --home-dir /home/appuser --shell /usr/sbin/nologin appuser \
&& mkdir -p /app/data \
&& chown -R appuser:appuser /app
# 非 root 运行,降低容器逃逸后的主机影响面
USER appuser
&& pip cache purge || true
# 环境变量配置
ENV HOST="0.0.0.0" \
PORT=12345 \
WORKERS=1 \
LOG_LEVEL="info" \
APP_ENV="production" \
LOG_LEVEL="warning" \
ACCESS_LOG="false" \
FORWARDED_ALLOW_IPS=""
EXPOSE 12345
@@ -84,4 +79,4 @@ EXPOSE 12345
# 生产环境启动命令
# FORWARDED_ALLOW_IPS 默认为空:仅信任直连 IP,避免任意客户端伪造 X-Forwarded-*。
# 若前面有反向代理,请显式设置为代理网段,例如 "10.0.0.0/8,172.16.0.0/12"。
CMD ["sh", "-c", "exec uvicorn main:app --host \"$HOST\" --port \"$PORT\" --workers \"$WORKERS\" --log-level \"$LOG_LEVEL\" --proxy-headers --forwarded-allow-ips \"${FORWARDED_ALLOW_IPS:-}\""]
CMD ["sh", "-c", "access_log_arg=--no-access-log; if [ \"${APP_ENV:-development}\" != \"production\" ] || [ \"${ACCESS_LOG:-false}\" = \"true\" ]; then access_log_arg=--access-log; fi; exec uvicorn main:app --host \"$HOST\" --port \"$PORT\" --workers \"$WORKERS\" --log-level \"$LOG_LEVEL\" \"$access_log_arg\" --proxy-headers --forwarded-allow-ips \"${FORWARDED_ALLOW_IPS:-}\""]
+1 -1
View File
@@ -1 +1 @@
2.5.3
2.5.6
+1
View File
@@ -43,6 +43,7 @@ async def get_chunk_file_path_name(
) -> Tuple[str, str, str, str, str]:
today = await get_now()
storage_path = settings.storage_path.strip("/")
file_name = await sanitize_filename(unquote(file_name or ""))
base_path = f"share/data/{today.strftime('%Y/%m/%d')}/{upload_id}"
path = f"{storage_path}/{base_path}" if storage_path else base_path
prefix, suffix = os.path.splitext(file_name)
+11 -7
View File
@@ -393,7 +393,8 @@ async def parse_complete_upload(request: Request) -> CompleteUploadModel:
@chunk_api.post("/upload/init/", dependencies=[Depends(share_required_login)])
async def init_chunk_upload(data: InitChunkUploadModel = Depends(parse_init_chunk_upload)):
validate_file_type(data.file_name)
safe_file_name = await sanitize_filename(unquote(data.file_name or ""))
validate_file_type(safe_file_name)
# 服务端校验:根据 total_chunks * chunk_size 计算理论最大上传量
total_chunks = (data.file_size + data.chunk_size - 1) // data.chunk_size
max_possible_size = total_chunks * data.chunk_size
@@ -423,7 +424,7 @@ async def init_chunk_upload(data: InitChunkUploadModel = Depends(parse_init_chun
chunk_hash=data.file_hash,
chunk_index=-1,
file_size=data.file_size,
file_name=data.file_name,
file_name=safe_file_name,
).first()
if existing_session:
@@ -459,7 +460,9 @@ async def init_chunk_upload(data: InitChunkUploadModel = Depends(parse_init_chun
await reserve_storage(
reservation_token, data.file_size, ttl_seconds=chunk_expire_seconds
)
_, _, _, _, save_path = await get_chunk_file_path_name(data.file_name, upload_id)
_, _, _, safe_file_name, save_path = await get_chunk_file_path_name(
data.file_name, upload_id
)
try:
await UploadChunk.create(
upload_id=upload_id,
@@ -468,7 +471,7 @@ async def init_chunk_upload(data: InitChunkUploadModel = Depends(parse_init_chun
file_size=data.file_size,
chunk_size=data.chunk_size,
chunk_hash=data.file_hash,
file_name=data.file_name,
file_name=safe_file_name,
save_path=save_path,
)
except Exception:
@@ -670,7 +673,8 @@ async def complete_upload(
save_path = chunk_info.save_path
path = os.path.dirname(save_path) if save_path else ""
prefix, suffix = os.path.splitext(chunk_info.file_name)
safe_file_name = os.path.basename(save_path) if save_path else ""
prefix, suffix = os.path.splitext(safe_file_name)
try:
# 合并文件并计算哈希
@@ -689,7 +693,7 @@ async def complete_upload(
expired_count=expired_count,
used_count=used_count,
file_path=path,
uuid_file_name=f"{prefix}{suffix}",
uuid_file_name=safe_file_name,
prefix=prefix,
suffix=suffix,
)
@@ -699,7 +703,7 @@ async def complete_upload(
await UploadChunk.filter(upload_id=upload_id).delete()
await release_storage(f"chunk:{upload_id}")
ip_limit["upload"].add_ip(ip)
return APIResponse(detail={"code": code, "name": chunk_info.file_name})
return APIResponse(detail={"code": code, "name": safe_file_name})
except ValueError as e:
raise HTTPException(status.HTTP_400_BAD_REQUEST, detail=str(e))
except Exception as e:
+46 -12
View File
@@ -1,26 +1,60 @@
import logging
import os
import sys
PRODUCTION_ENVIRONMENTS = {"production", "prod"}
LOG_LEVELS = {
"debug": logging.DEBUG,
"info": logging.INFO,
"warning": logging.WARNING,
"error": logging.ERROR,
"critical": logging.CRITICAL,
}
def is_production_environment() -> bool:
environment = os.getenv("APP_ENV", "development").strip().lower()
return environment in PRODUCTION_ENVIRONMENTS
def get_log_level_name() -> str:
configured_level = os.getenv("LOG_LEVEL", "").strip().lower()
if configured_level in LOG_LEVELS:
return configured_level
return "warning" if is_production_environment() else "info"
def get_log_level() -> int:
return LOG_LEVELS[get_log_level_name()]
def is_access_log_enabled() -> bool:
configured_value = os.getenv("ACCESS_LOG")
if configured_value is not None:
return configured_value.strip().lower() in {"1", "true", "yes", "on"}
return not is_production_environment()
def setup_logger():
# 创建logger对象
_logger = logging.getLogger('FileCodeBox')
_logger.setLevel(logging.INFO)
_logger = logging.getLogger("FileCodeBox")
level = get_log_level()
_logger.setLevel(level)
_logger.propagate = False
# 创建控制台处理器
console_handler = logging.StreamHandler(sys.stdout)
console_handler.setLevel(logging.INFO)
if not _logger.handlers:
console_handler = logging.StreamHandler(sys.stdout)
_logger.addHandler(console_handler)
else:
console_handler = _logger.handlers[0]
console_handler.setLevel(level)
# 设置日志格式
formatter = logging.Formatter(
'%(asctime)s - %(name)s - %(levelname)s - %(message)s',
datefmt='%Y-%m-%d %H:%M:%S'
"%(asctime)s - %(name)s - %(levelname)s - %(message)s",
datefmt="%Y-%m-%d %H:%M:%S",
)
console_handler.setFormatter(formatter)
# 添加处理器到logger
_logger.addHandler(console_handler)
return _logger
+10 -8
View File
@@ -116,6 +116,8 @@ class SystemFileStorage(FileStorageInterface):
"""将相对路径解析到数据根目录内,阻止路径穿越。"""
root = self.root_path.resolve()
raw = str(relative_path or "").replace("\\", "/").lstrip("/")
if any(part == ".." for part in raw.split("/")):
raise ValueError("非法文件路径")
candidate = (root / raw).resolve()
try:
candidate.relative_to(root)
@@ -257,14 +259,14 @@ class SystemFileStorage(FileStorageInterface):
try:
shutil.rmtree(chunk_dir)
except Exception as e:
logger.info(f"清理本地分片目录失败: {e}")
logger.warning(f"清理本地分片目录失败: {e}")
# 清理父级 chunks 目录(如果为空)
chunks_parent = chunk_dir.parent
if chunks_parent.exists() and not any(chunks_parent.iterdir()):
try:
chunks_parent.rmdir()
except Exception as e:
logger.info(f"清理 chunks 父目录失败: {e}")
logger.warning(f"清理 chunks 父目录失败: {e}")
async def file_exists(self, save_path: str) -> bool:
"""
@@ -535,7 +537,7 @@ class S3FileStorage(FileStorageInterface):
Delete={'Objects': delete_objects}
)
except Exception as e:
logger.info(f"清理 S3 分片数据时出错: {e}")
logger.warning(f"清理 S3 分片数据时出错: {e}")
async def generate_presigned_upload_url(self, save_path: str, expires_in: int = 900) -> Optional[str]:
"""
@@ -863,7 +865,7 @@ class OneDriveFileStorage(FileStorageInterface):
try:
await asyncio.to_thread(self._delete_chunk_dir, chunk_dir)
except Exception as e:
logger.info(f"清理 OneDrive 分片时出错: {e}")
logger.warning(f"清理 OneDrive 分片时出错: {e}")
def _file_exists(self, save_path: str) -> bool:
"""同步检查文件是否存在"""
@@ -1021,7 +1023,7 @@ class OpenDALFileStorage(FileStorageInterface):
# OpenDAL 支持递归删除
await self.operator.remove_all(chunk_dir)
except Exception as e:
logger.info(f"清理 OpenDAL 分片时出错: {e}")
logger.warning(f"清理 OpenDAL 分片时出错: {e}")
async def file_exists(self, save_path: str) -> bool:
"""
@@ -1332,16 +1334,16 @@ class WebDAVFileStorage(FileStorageInterface):
file_url = self._build_url(file_path)
async with session.delete(file_url) as delete_resp:
if delete_resp.status not in (200, 204, 404):
logger.info(f"删除分片文件失败: {file_path}")
logger.warning(f"删除分片文件失败: {file_path}")
# 删除分片目录
async with session.delete(chunk_dir_url) as delete_resp:
if delete_resp.status not in (200, 204, 404):
logger.info(f"删除分片目录失败: {chunk_dir_url}")
logger.warning(f"删除分片目录失败: {chunk_dir_url}")
else:
logger.info(f"分片目录不存在: {chunk_dir_url}")
except Exception as e:
logger.info(f"清理 WebDAV 分片时出错: {e}")
logger.warning(f"清理 WebDAV 分片时出错: {e}")
async def file_exists(self, save_path: str) -> bool:
"""
+10 -10
View File
@@ -4,7 +4,6 @@
# @Software: PyCharm
import asyncio
import datetime
import logging
import os
from tortoise.expressions import Q
@@ -17,6 +16,7 @@ from apps.base.models import (
)
from apps.base.utils import ip_limit, get_chunk_file_path_name
from core.config import refresh_settings
from core.logger import logger
from core.settings import settings, data_root
from core.storage import FileStorageInterface, storages
from core.utils import get_now
@@ -43,13 +43,13 @@ async def delete_expire_files():
try:
await file_storage.delete_file(exp)
except Exception as e:
logging.error(f"删除过期文件失败 code={exp.code}: {e}")
logger.error(f"删除过期文件失败 code={exp.code}: {e}")
try:
await exp.delete()
except Exception as e:
logging.error(f"删除记录失败 code={exp.code}: {e}")
logger.error(f"删除记录失败 code={exp.code}: {e}")
except Exception as e:
logging.error(e)
logger.error(e)
finally:
await asyncio.sleep(600)
@@ -75,7 +75,7 @@ async def clean_incomplete_uploads():
)
await file_storage.clean_chunks(session.upload_id, save_path)
except Exception as e:
logging.error(
logger.error(
f"清理分片文件失败 upload_id={session.upload_id}: {e}"
)
@@ -84,14 +84,14 @@ async def clean_incomplete_uploads():
await StorageReservation.filter(
token=f"chunk:{session.upload_id}"
).delete()
logging.info(f"已清理过期上传会话 upload_id={session.upload_id}")
logger.info(f"已清理过期上传会话 upload_id={session.upload_id}")
except Exception as e:
logging.error(
logger.error(
f"删除分片记录失败 upload_id={session.upload_id}: {e}"
)
except Exception as e:
logging.error(f"清理未完成上传任务异常: {e}")
logger.error(f"清理未完成上传任务异常: {e}")
finally:
await asyncio.sleep(3600)
@@ -116,7 +116,7 @@ async def clean_expired_presign_sessions():
)
)
except Exception as e:
logging.error(
logger.error(
"清理过期直传文件失败 "
f"upload_id={session.upload_id}: {e}"
)
@@ -125,6 +125,6 @@ async def clean_expired_presign_sessions():
).delete()
await session.delete()
except Exception as e:
logging.error(f"清理过期预签名会话异常: {e}")
logger.error(f"清理过期预签名会话异常: {e}")
finally:
await asyncio.sleep(900)
+11 -2
View File
@@ -1,13 +1,22 @@
version: "3"
services:
file-code-box:
image: lanol/filecodebox:2.5.3 # x-release-please-version
user: "1000:1000"
image: lanol/filecodebox:2.5.6 # x-release-please-version
volumes:
- fcb-data:/app/data:rw
restart: unless-stopped
ports:
- "12345:12345"
environment:
- APP_ENV=production
- LOG_LEVEL=warning
- ACCESS_LOG=false
- WORKERS=1
logging:
driver: json-file
options:
max-size: "10m"
max-file: "3"
volumes:
fcb-data:
external: false
+24
View File
@@ -1,5 +1,29 @@
# Changelog
## [2.5.6](https://github.com/vastsa/FileCodeBox/compare/v2.5.5...v2.5.6) (2026-09-01)
### Bug Fixes
* **logging:** reduce production log noise ([5537f56](https://github.com/vastsa/FileCodeBox/commit/5537f56b884a15eda015665c67c3f8469e4e9d89))
## [2.5.5](https://github.com/vastsa/FileCodeBox/compare/v2.5.4...v2.5.5) (2026-08-29)
### Bug Fixes
* **chunk-upload:** persist sanitized filenames ([da1dd06](https://github.com/vastsa/FileCodeBox/commit/da1dd066551cc7cc9a631a0c982b5675bd4b1967))
* harden chunk upload filename metadata ([5a7195c](https://github.com/vastsa/FileCodeBox/commit/5a7195c5c7d1028500b0e363c6b47130d260e11c))
* sanitize chunk upload file_name to prevent path traversal ([cebac32](https://github.com/vastsa/FileCodeBox/commit/cebac32145f948bfca7c44c663a0bcdcd9c56830))
## [2.5.4](https://github.com/vastsa/FileCodeBox/compare/v2.5.3...v2.5.4) (2026-07-23)
### Bug Fixes
* run Docker as root for volume compatibility ([fbcd4a5](https://github.com/vastsa/FileCodeBox/commit/fbcd4a5b2b788cdfc8e86d920f9c5a7299dc839a))
* run Docker image as root for data volume compatibility ([fc0cbeb](https://github.com/vastsa/FileCodeBox/commit/fc0cbeb4f0c7485d2e7abc0501a5fd9b1456cc22))
## [2.5.3](https://github.com/vastsa/FileCodeBox/compare/v2.5.2...v2.5.3) (2026-07-23)
+1 -1
View File
@@ -1,6 +1,6 @@
## [Unreleased]
<!-- Current release: 2.5.3 x-release-please-version -->
<!-- Current release: 2.5.6 x-release-please-version -->
### Added
+9 -1
View File
@@ -21,6 +21,10 @@ FileCodeBox is a simple and efficient file sharing tool that supports temporary
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v fcb-data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:latest
```
@@ -32,7 +36,11 @@ The named volume persists configuration and uploaded files across container upgr
| `HOST` | `0.0.0.0` | Service listening address |
| `PORT` | `12345` | Service port |
| `WORKERS` | `1` | Worker count; keep one worker for SQLite deployments |
| `LOG_LEVEL` | `info` | `debug`, `info`, `warning`, or `error` |
| `APP_ENV` | `production` (Docker) | Runtime environment; production disables HTTP access logs by default |
| `LOG_LEVEL` | `warning` (Docker) | `debug`, `info`, `warning`, or `error` |
| `ACCESS_LOG` | `false` (production) | Enable HTTP access logs; set to `true` when debugging requests |
Production deployments output only warning, error, and other key events by default. Docker retains at most three 10 MB log files.
### Manual Deployment
+10 -2
View File
@@ -1,6 +1,6 @@
<div align="center">
<img src="https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png" alt="FileCodeBox Logo">
<img src="/screenshots/retrieve.webp" alt="FileCodeBox" width="860" />
<p><em>Share text and files anonymously with a passcode, like picking up a package</em></p>
@@ -136,7 +136,15 @@ Command-line download
### Docker Deployment
```bash
docker run -d --restart unless-stopped -p 12345:12345 -v fcb-data:/app/data --name filecodebox lanol/filecodebox:latest
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v fcb-data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:latest
```
### Manual Deployment
+16
View File
@@ -4,6 +4,10 @@ FileCodeBox provides a fully-featured admin panel that allows administrators to
## Accessing the Admin Panel
<p align="center">
<img src="/screenshots/login.webp" alt="Admin login" width="640" />
</p>
### Login Method
The admin panel is located at the `/admin` path. Access method:
@@ -39,6 +43,10 @@ The admin panel uses JWT (JSON Web Token) for authentication:
## Dashboard
<p align="center">
<img src="/screenshots/dashboard.webp" alt="Dashboard" width="860" />
</p>
After logging in, you first see the dashboard page, which displays the overall system status.
### Statistics
@@ -67,6 +75,10 @@ Storage usage is displayed in bytes. For example, `10485760` represents approxim
## File Management
<p align="center">
<img src="/screenshots/files.webp" alt="File management" width="860" />
</p>
### File List
The file management page displays all shared files in the system, supporting pagination and search.
@@ -200,6 +212,10 @@ Local file management is useful for:
## System Settings
<p align="center">
<img src="/screenshots/settings.webp" alt="System settings" width="860" />
</p>
### View Configuration
On the system settings page, you can view the current values of all configuration items. Configuration items are grouped by category:
+8
View File
@@ -4,6 +4,10 @@ FileCodeBox provides simple and easy-to-use file and text sharing functionality.
## Sharing Methods
<p align="center">
<img src="/screenshots/send.webp" alt="Send page" width="720" />
</p>
FileCodeBox supports two sharing methods:
1. **Text Sharing** - Share text content directly, suitable for code snippets, configuration files, etc.
@@ -137,6 +141,10 @@ expire_value=5, expire_style=count
## Retrieving Files
<p align="center">
<img src="/screenshots/retrieve.webp" alt="Retrieve page" width="720" />
</p>
### How to Use
1. Enter the extraction code in the "Retrieve File" area on the homepage
+4
View File
@@ -4,6 +4,10 @@ FileCodeBox provides multiple flexible file upload methods, supporting both regu
## Upload Methods
<p align="center">
<img src="/screenshots/send.webp" alt="Upload and send page" width="720" />
</p>
FileCodeBox supports the following upload methods:
### Drag and Drop Upload
+25 -1
View File
@@ -37,8 +37,12 @@ features:
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v ./data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:2.5.3 # x-release-please-version
lanol/filecodebox:2.5.6 # x-release-please-version
```
Open `http://localhost:12345` and complete the first-run setup.
@@ -61,6 +65,26 @@ Open `http://localhost:12345` and complete the first-run setup.
</a>
</div>
## Interface preview
<p align="center">
<img src="/screenshots/retrieve.webp" alt="Retrieve files" width="860" />
</p>
<p align="center">
<img src="/screenshots/send.webp" alt="Send files" width="48%" />
&nbsp;
<img src="/screenshots/dashboard.webp" alt="Admin dashboard" width="48%" />
</p>
<table>
<tr>
<td width="33%"><img src="/screenshots/login.webp" alt="Admin login" /></td>
<td width="33%"><img src="/screenshots/files.webp" alt="File management" /></td>
<td width="33%"><img src="/screenshots/settings.webp" alt="System settings" /></td>
</tr>
</table>
::: warning Responsible use
Use FileCodeBox only for lawful file and text sharing. Operators are responsible for deployment security, data compliance, and content moderation.
:::
+20 -2
View File
@@ -23,6 +23,10 @@ FileCodeBox 是一个简单高效的文件分享工具,支持文件临时中
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v fcb-data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:latest
```
@@ -40,8 +44,15 @@ services:
ports:
- "12345:12345"
environment:
- APP_ENV=production
- WORKERS=1
- LOG_LEVEL=info
- LOG_LEVEL=warning
- ACCESS_LOG=false
logging:
driver: json-file
options:
max-size: "10m"
max-file: "3"
volumes:
fcb-data:
external: false
@@ -54,7 +65,11 @@ volumes:
| `HOST` | `0.0.0.0` | 服务监听地址 |
| `PORT` | `12345` | 服务端口 |
| `WORKERS` | `1` | 工作进程数;SQLite 部署建议保持单进程 |
| `LOG_LEVEL` | `info` | 日志级别:debug/info/warning/error |
| `APP_ENV` | `production`(Docker) | 运行环境;生产环境默认关闭 HTTP 访问日志 |
| `LOG_LEVEL` | `warning`(Docker) | 日志级别:debug/info/warning/error |
| `ACCESS_LOG` | `false`(生产环境) | 是否启用 HTTP 访问日志;调试请求时可设为 `true` |
生产环境默认只输出 warning、error 等关键日志,并限制 Docker 日志最多保留 3 个 10 MB 文件。
#### 自定义配置示例
@@ -63,8 +78,11 @@ docker run -d --restart=always \
-p 12345:12345 \
-v fcb-data:/app/data \
-e WORKERS=1 \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--name filecodebox \
--log-opt max-size=10m \
--log-opt max-file=3 \
lanol/filecodebox:latest
```
+32 -2
View File
@@ -1,6 +1,6 @@
<div align="center">
<img src="https://fastly.jsdelivr.net/gh/vastsa/FileCodeBox@V1.6/static/banners/img_1.png" alt="FileCodeBox Logo">
<img src="/screenshots/retrieve.webp" alt="FileCodeBox" width="860" />
<p><em>匿名口令分享文本和文件,像拿快递一样取文件</em></p>
@@ -15,6 +15,28 @@
</div>
## 🖼️ 界面预览
<p align="center">
<img src="/screenshots/retrieve.webp" alt="提取文件" width="860" />
</p>
<p align="center">
<img src="/screenshots/send.webp" alt="文件发送" width="48%" />
&nbsp;
<img src="/screenshots/dashboard.webp" alt="管理仪表盘" width="48%" />
</p>
<p align="center">
<img src="/screenshots/files.webp" alt="文件管理" width="48%" />
&nbsp;
<img src="/screenshots/settings.webp" alt="系统设置" width="48%" />
</p>
<p align="center">
<img src="/screenshots/login.webp" alt="管理登录" width="60%" />
</p>
## 🚀 更新计划
- [ ] 切片上传,同文件秒传,断点续传
- [ ] 用户登录重构
@@ -128,7 +150,15 @@ FileCodeBox 是一个基于 FastAPI + Vue3 开发的轻量级文件分享工具
### Docker 部署
```bash
docker run -d --restart unless-stopped -p 12345:12345 -v fcb-data:/app/data --name filecodebox lanol/filecodebox:latest
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v fcb-data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:latest
```
### 手动部署
+16
View File
@@ -4,6 +4,10 @@ FileCodeBox 提供了功能完善的管理面板,让管理员可以方便地
## 访问管理面板
<p align="center">
<img src="/screenshots/login.webp" alt="管理登录" width="640" />
</p>
### 登录方式
管理面板位于 `/admin` 路径。访问方式:
@@ -39,6 +43,10 @@ FileCodeBox 提供了功能完善的管理面板,让管理员可以方便地
## 仪表盘
<p align="center">
<img src="/screenshots/dashboard.webp" alt="管理仪表盘" width="860" />
</p>
登录后首先看到的是仪表盘页面,展示系统的整体运行状态。
### 统计指标
@@ -67,6 +75,10 @@ FileCodeBox 提供了功能完善的管理面板,让管理员可以方便地
## 文件管理
<p align="center">
<img src="/screenshots/files.webp" alt="文件管理" width="860" />
</p>
### 文件列表
文件管理页面展示系统中所有已分享的文件,支持分页浏览和搜索。
@@ -199,6 +211,10 @@ FileCodeBox 提供了功能完善的管理面板,让管理员可以方便地
## 系统设置
<p align="center">
<img src="/screenshots/settings.webp" alt="系统设置" width="860" />
</p>
### 查看配置
在系统设置页面可以查看当前所有配置项的值。配置项按类别分组显示:
+8
View File
@@ -4,6 +4,10 @@ FileCodeBox 提供了简单易用的文件和文本分享功能。用户可以
## 分享方式
<p align="center">
<img src="/screenshots/send.webp" alt="文件发送页面" width="720" />
</p>
FileCodeBox 支持两种分享方式:
1. **文本分享** - 直接分享文本内容,适合代码片段、配置文件等
@@ -136,6 +140,10 @@ expire_value=5, expire_style=count
## 提取文件
<p align="center">
<img src="/screenshots/retrieve.webp" alt="提取文件页面" width="720" />
</p>
### 使用方法
1. 在首页的「提取文件」区域输入提取码
+4
View File
@@ -4,6 +4,10 @@ FileCodeBox 提供了多种灵活的文件上传方式,支持普通上传和
## 上传方式
<p align="center">
<img src="/screenshots/send.webp" alt="上传与发送页面" width="720" />
</p>
FileCodeBox 支持以下几种上传方式:
### 拖拽上传
+25 -1
View File
@@ -37,8 +37,12 @@ features:
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v ./data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:2.5.3 # x-release-please-version
lanol/filecodebox:2.5.6 # x-release-please-version
```
打开 `http://localhost:12345`,按引导完成首次初始化。
@@ -61,6 +65,26 @@ docker run -d --restart unless-stopped \
</a>
</div>
## 界面预览
<p align="center">
<img src="/screenshots/retrieve.webp" alt="提取文件" width="860" />
</p>
<p align="center">
<img src="/screenshots/send.webp" alt="文件发送" width="48%" />
&nbsp;
<img src="/screenshots/dashboard.webp" alt="管理仪表盘" width="48%" />
</p>
<table>
<tr>
<td width="33%"><img src="/screenshots/login.webp" alt="管理登录" /></td>
<td width="33%"><img src="/screenshots/files.webp" alt="文件管理" /></td>
<td width="33%"><img src="/screenshots/settings.webp" alt="系统设置" /></td>
</tr>
</table>
::: warning 使用须知
请仅将 FileCodeBox 用于合法的文件与文本分享。服务运营者应自行负责部署安全、数据合规和内容管理。
:::
Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

+3 -1
View File
@@ -26,7 +26,7 @@ from core.config import (
refresh_settings,
)
from core.database import db_startup_lock, get_db_config, init_db
from core.logger import logger
from core.logger import get_log_level_name, is_access_log_enabled, logger
from core.response import APIResponse
from core.settings import settings, BASE_DIR, DEFAULT_CONFIG
from core.tasks import (
@@ -933,4 +933,6 @@ if __name__ == "__main__":
port=settings.serverPort,
reload=False,
workers=settings.serverWorkers,
log_level=get_log_level_name(),
access_log=is_access_log_enabled(),
)
+19 -11
View File
@@ -17,14 +17,22 @@
<br />
<img src="./.github/images/readme/retrieve-dark.png" alt="FileCodeBox 取件页面" width="860" />
<img src="./.github/images/readme/banner_zh.webp" alt="FileCodeBox" width="100%" />
</div>
## 一条命令开始
```bash
docker run -d --restart unless-stopped -p 12345:12345 -v ./data:/app/data --name filecodebox lanol/filecodebox:2.5.3 # x-release-please-version
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v ./data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:2.5.6 # x-release-please-version
```
访问 `http://localhost:12345`,完成首次初始化。生产环境建议固定版本号;`latest` 指向最新正式版。
@@ -43,18 +51,18 @@ docker run -d --restart unless-stopped -p 12345:12345 -v ./data:/app/data --name
<table>
<tr>
<td width="50%"><img src="./.github/images/readme/send.png" alt="文件发送页面" /></td>
<td width="50%"><img src="./.github/images/readme/dashboard.png" alt="管理仪表盘" /></td>
<td width="50%"><img src="./.github/images/readme/send.webp" alt="文件发送页面" /></td>
<td width="50%"><img src="./.github/images/readme/dashboard.webp" alt="管理仪表盘" /></td>
</tr>
</table>
<p align="center">
<img src="./.github/images/readme/mobile-retrieve.png" alt="移动端取件" width="29%" />
&nbsp;&nbsp;
<img src="./.github/images/readme/mobile-send.png" alt="移动端发送" width="29%" />
&nbsp;&nbsp;
<img src="./.github/images/readme/mobile-files.png" alt="移动端管理" width="29%" />
</p>
<table>
<tr>
<td width="33%"><img src="./.github/images/readme/login.webp" alt="管理登录" /></td>
<td width="33%"><img src="./.github/images/readme/files.webp" alt="文件管理" /></td>
<td width="33%"><img src="./.github/images/readme/settings.webp" alt="系统设置" /></td>
</tr>
</table>
<div align="center">
+19 -11
View File
@@ -17,14 +17,22 @@ A lightweight, modern, self-hosted file sharing service. No account required—u
<br />
<img src="./.github/images/readme/retrieve-dark.png" alt="FileCodeBox retrieval screen" width="860" />
<img src="./.github/images/readme/banner_en.webp" alt="FileCodeBox" width="100%" />
</div>
## Start with one command
```bash
docker run -d --restart unless-stopped -p 12345:12345 -v ./data:/app/data --name filecodebox lanol/filecodebox:2.5.3 # x-release-please-version
docker run -d --restart unless-stopped \
-p 12345:12345 \
-v ./data:/app/data \
-e APP_ENV=production \
-e LOG_LEVEL=warning \
--log-opt max-size=10m \
--log-opt max-file=3 \
--name filecodebox \
lanol/filecodebox:2.5.6 # x-release-please-version
```
Open `http://localhost:12345` and complete first-run setup. Pin a version in production; `latest` tracks the newest stable release.
@@ -43,18 +51,18 @@ Open `http://localhost:12345` and complete first-run setup. Pin a version in pro
<table>
<tr>
<td width="50%"><img src="./.github/images/readme/send.png" alt="File sharing screen" /></td>
<td width="50%"><img src="./.github/images/readme/dashboard.png" alt="Admin dashboard" /></td>
<td width="50%"><img src="./.github/images/readme/send.webp" alt="File sharing screen" /></td>
<td width="50%"><img src="./.github/images/readme/dashboard.webp" alt="Admin dashboard" /></td>
</tr>
</table>
<p align="center">
<img src="./.github/images/readme/mobile-retrieve.png" alt="Mobile retrieval" width="29%" />
&nbsp;&nbsp;
<img src="./.github/images/readme/mobile-send.png" alt="Mobile sharing" width="29%" />
&nbsp;&nbsp;
<img src="./.github/images/readme/mobile-files.png" alt="Mobile administration" width="29%" />
</p>
<table>
<tr>
<td width="33%"><img src="./.github/images/readme/login.webp" alt="Admin login" /></td>
<td width="33%"><img src="./.github/images/readme/files.webp" alt="File management" /></td>
<td width="33%"><img src="./.github/images/readme/settings.webp" alt="System settings" /></td>
</tr>
</table>
<div align="center">
+60
View File
@@ -0,0 +1,60 @@
import importlib
import logging
import os
import unittest
from pathlib import Path
from unittest.mock import patch
import core.logger as logger_module
class LoggingConfigurationTests(unittest.TestCase):
def setUp(self):
self.environment_patch = None
def tearDown(self):
if self.environment_patch is not None:
self.environment_patch.stop()
importlib.reload(logger_module)
def reload_with_environment(self, values):
self.environment_patch = patch.dict(os.environ, values, clear=True)
self.environment_patch.start()
return importlib.reload(logger_module)
def test_production_defaults_to_warning_and_disables_access_logs(self):
module = self.reload_with_environment({"APP_ENV": "production"})
self.assertEqual(module.get_log_level_name(), "warning")
self.assertEqual(module.logger.level, logging.WARNING)
self.assertFalse(module.is_access_log_enabled())
def test_development_defaults_to_info_and_keeps_access_logs(self):
module = self.reload_with_environment({"APP_ENV": "development"})
self.assertEqual(module.get_log_level_name(), "info")
self.assertEqual(module.logger.level, logging.INFO)
self.assertTrue(module.is_access_log_enabled())
def test_explicit_log_and_access_settings_override_environment_defaults(self):
module = self.reload_with_environment(
{"APP_ENV": "production", "LOG_LEVEL": "error", "ACCESS_LOG": "true"}
)
self.assertEqual(module.get_log_level_name(), "error")
self.assertEqual(module.logger.level, logging.ERROR)
self.assertTrue(module.is_access_log_enabled())
def test_log_file_configuration_is_bounded_in_docker_compose(self):
compose = Path("docker-compose.yml").read_text(encoding="utf-8")
dockerfile = Path("Dockerfile").read_text(encoding="utf-8")
self.assertIn('max-size: "10m"', compose)
self.assertIn('max-file: "3"', compose)
self.assertIn('APP_ENV="production"', dockerfile)
self.assertIn('LOG_LEVEL="warning"', dockerfile)
self.assertIn("--no-access-log", dockerfile)
if __name__ == "__main__":
unittest.main()
+5 -5
View File
@@ -90,13 +90,13 @@ class LoginRateLimitTests(SettingsOverrideMixin, unittest.TestCase):
self.assertTrue(ip_limit["login"].check_ip("198.51.100.8"))
class DockerNonRootTests(unittest.TestCase):
def test_dockerfile_runs_as_non_root_user(self):
class DockerRuntimeUserTests(unittest.TestCase):
def test_dockerfile_defaults_to_root_for_volume_compatibility(self):
# 默认 root:兼容已有 data 卷权限;如需非 root 可由编排层自行指定 user
text = Path("Dockerfile").read_text()
self.assertIn("USER appuser", text)
self.assertIn("--uid 1000", text)
self.assertNotIn("USER appuser", text)
compose = Path("docker-compose.yml").read_text()
self.assertIn('user: "1000:1000"', compose)
self.assertNotIn('user: "1000:1000"', compose)
if __name__ == "__main__":
+129
View File
@@ -1,4 +1,5 @@
import asyncio
from io import BytesIO
import os
import tempfile
import unittest
@@ -6,10 +7,16 @@ from pathlib import Path
from unittest.mock import patch
from fastapi import HTTPException
from starlette.datastructures import UploadFile
from tortoise import Tortoise
from apps.base import views
from apps.admin import dependencies as admin_dependencies
from apps.admin.dependencies import create_token, verify_token
from apps.admin.services import LocalFileClass
from apps.base.models import FileCodes, UploadChunk
from apps.base.schemas import CompleteUploadModel, InitChunkUploadModel
from apps.base.utils import get_chunk_file_path_name
from core.settings import data_root, settings
from core.storage import SystemFileStorage
from core.utils import hash_password, verify_password
@@ -71,11 +78,133 @@ class SystemStoragePathTests(unittest.TestCase):
with self.assertRaises(ValueError):
self.storage._resolve_safe_path("../etc/passwd")
def test_resolve_safe_path_blocks_internal_dotdot(self):
with self.assertRaises(ValueError):
self.storage._resolve_safe_path("share/data/2026/08/29/x/../../../../../../filecodebox.db")
def test_resolve_safe_path_blocks_windows_dotdot(self):
with self.assertRaises(ValueError):
self.storage._resolve_safe_path("share\\data\\..\\..\\filecodebox.db")
def test_resolve_safe_path_allows_nested(self):
target = self.storage._resolve_safe_path("share/data/a/b.txt")
self.assertTrue(str(target).startswith(str(Path(self._tmpdir.name).resolve())))
class ChunkFileNameSanitizeTests(unittest.TestCase):
def test_chunk_file_path_name_strips_traversal(self):
path, _, _, filename, save_path = asyncio.run(
get_chunk_file_path_name("../../../../../../filecodebox.db", "a" * 32)
)
self.assertNotIn("..", save_path)
self.assertEqual(filename, "filecodebox.db")
self.assertEqual(save_path, f"{path}/filecodebox.db")
self.assertIn("a" * 32, path)
def test_chunk_file_path_name_strips_windows_traversal(self):
_, _, _, filename, save_path = asyncio.run(
get_chunk_file_path_name("..\\..\\..\\..\\..\\..\\evil.bin", "b" * 32)
)
self.assertNotIn("..", save_path)
self.assertEqual(filename, "evil.bin")
def test_chunk_file_path_name_keeps_normal_name(self):
_, _, _, filename, save_path = asyncio.run(
get_chunk_file_path_name("safe.txt", "c" * 32)
)
self.assertEqual(filename, "safe.txt")
self.assertTrue(save_path.endswith("/safe.txt"))
class ChunkUploadMetadataTests(unittest.TestCase):
def test_traversal_filename_remains_downloadable_after_completion(self):
asyncio.run(self._run_traversal_upload())
async def _run_traversal_upload(self):
original_config = dict(settings.user_config)
tmpdir = tempfile.TemporaryDirectory()
try:
settings.file_storage = "local"
settings.allowed_file_types = ["*"]
with patch("core.storage.data_root", Path(tmpdir.name)):
await Tortoise.init(
config={
"connections": {
"default": {
"engine": "tortoise.backends.sqlite",
"credentials": {"file_path": ":memory:"},
}
},
"apps": {
"models": {
"models": ["apps.base.models"],
"default_connection": "default",
}
},
"use_tz": False,
"timezone": "Asia/Shanghai",
}
)
await Tortoise.generate_schemas()
try:
raw_name = "../../../../../../filecodebox.db"
payload = b"chunk payload"
init_result = await views.init_chunk_upload(
InitChunkUploadModel(
file_name=raw_name,
file_size=len(payload),
chunk_size=1024,
file_hash="f" * 64,
)
)
upload_id = init_result.detail["upload_id"]
session = await UploadChunk.get(
upload_id=upload_id, chunk_index=-1
)
self.assertEqual(session.file_name, "filecodebox.db")
self.assertNotIn("..", session.save_path)
await views.upload_chunk(
upload_id=upload_id,
chunk_index=0,
chunk=UploadFile(
file=BytesIO(payload), filename="filecodebox.db"
),
)
# Simulate a legacy session whose display name was not sanitized.
session.file_name = raw_name
await session.save(update_fields=["file_name"])
complete_result = await views.complete_upload(
upload_id=upload_id,
data=CompleteUploadModel(
expire_value=1, expire_style="day"
),
ip="127.0.0.1",
)
self.assertEqual(complete_result.detail["name"], "filecodebox.db")
file_code = await FileCodes.get(code=complete_result.detail["code"])
expected_relative_path = session.save_path
self.assertEqual(
await file_code.get_file_path(), expected_relative_path
)
storage = views.storages[settings.file_storage]()
resolved_path = storage._resolve_safe_path(
await file_code.get_file_path()
)
self.assertEqual(
resolved_path, Path(tmpdir.name).resolve() / expected_relative_path
)
self.assertEqual(resolved_path.read_bytes(), payload)
finally:
await Tortoise.close_connections()
finally:
settings.user_config = original_config
tmpdir.cleanup()
class AdminJwtUrlSafeTests(unittest.TestCase):
def setUp(self):
settings.jwt_secret = "j" * 48