mirror of
https://github.com/vastsa/FileCodeBox.git
synced 2026-11-22 06:57:56 +08:00
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
99 lines
4.1 KiB
Markdown
99 lines
4.1 KiB
Markdown
<div align="center">
|
||
|
||
<img src="./docs/public/logo_small.png" alt="FileCodeBox" width="96" />
|
||
|
||
# FileCodeBox
|
||
|
||
### Share files like picking up a package
|
||
|
||
A lightweight, modern, self-hosted file sharing service. No account required—upload, share the passcode, and retrieve.
|
||
|
||
[Live Demo](https://share.lanol.cn) · [Documentation](https://fcb-docs.aiuo.net/en/) · [简体中文](./readme.md)
|
||
|
||
[](https://github.com/vastsa/FileCodeBox/releases/latest)
|
||
[](https://hub.docker.com/r/lanol/filecodebox)
|
||
[](https://github.com/vastsa/FileCodeBox/stargazers)
|
||
[](./LICENSE)
|
||
|
||
<br />
|
||
|
||
<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 \
|
||
-e APP_ENV=production \
|
||
-e LOG_LEVEL=warning \
|
||
--log-opt max-size=10m \
|
||
--log-opt max-file=3 \
|
||
--name filecodebox \
|
||
lanol/filecodebox:2.9.0 # x-release-please-version
|
||
```
|
||
|
||
Open `http://localhost:12345` and complete first-run setup. Pin a version in production; `latest` tracks the newest stable release.
|
||
## MCP for AI clients
|
||
|
||
FileCodeBox supports **MCP over Streamable HTTP**, allowing compatible AI clients to create text and file shares. Use `http://<your-server>:12345/mcp` (or `http://localhost:12345/mcp` for a local instance). No token is required by default. The available tools are `share_text` and `share_file`. If guest uploads are disabled or MCP token validation is enabled, configure `Authorization: Bearer <admin token>` in the client.
|
||
|
||
See the [MCP integration guide](https://fcb-docs.aiuo.net/en/guide/mcp).
|
||
|
||
## Simple, yet capable
|
||
|
||
<table>
|
||
<tr>
|
||
<td width="33%" valign="top"><b>Share instantly</b><br /><sub>Files and text in one flow, with drag, paste, batch, and chunked uploads.</sub></td>
|
||
<td width="33%" valign="top"><b>Expire on your terms</b><br /><sub>Expire by time or retrieval count, keep forever, and clean up automatically.</sub></td>
|
||
<td width="33%" valign="top"><b>Own your data</b><br /><sub>Local, S3, OneDrive, WebDAV, and OpenDAL storage on infrastructure you control.</sub></td>
|
||
</tr>
|
||
</table>
|
||
|
||
## From sharing to administration
|
||
|
||
<table>
|
||
<tr>
|
||
<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>
|
||
|
||
<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">
|
||
|
||
`FastAPI` `Vue 3` `SQLite` `Docker` `S3` `WebDAV` `Dark Mode`
|
||
|
||
</div>
|
||
|
||
## Learn more
|
||
|
||
- [Getting started](https://fcb-docs.aiuo.net/en/guide/getting-started) · deployment, setup, and upgrades
|
||
- [Storage](https://fcb-docs.aiuo.net/en/guide/storage) · local and object storage
|
||
- [Security](https://fcb-docs.aiuo.net/en/guide/security) · rate limits, sessions, and access protection
|
||
- [API reference](https://fcb-docs.aiuo.net/en/api/) · upload, retrieval, and administration
|
||
- [Frontend source](https://github.com/vastsa/FileCodeBoxFronted) · the active 2024 theme
|
||
|
||
## Contributing
|
||
|
||
[Issues](https://github.com/vastsa/FileCodeBox/issues/new/choose) and pull requests are welcome. FileCodeBox is released under [LGPL-3.0](./LICENSE).
|
||
|
||
## Disclaimer
|
||
|
||
Use FileCodeBox only for lawful file and text sharing. Do not upload, store, or distribute illegal, infringing, or unauthorized content. Operators are responsible for deployment security, data compliance, and content moderation.
|
||
|
||
<div align="center">
|
||
|
||
**If FileCodeBox helps you, consider leaving a Star.**
|
||
|
||
</div>
|