根据 MicroBin 的官方仓库,这是一个基于 Rust 编写的、超轻量且功能丰富的自托管粘贴箱与文件分享 Web 应用。以下是基于其文档整理的部署与使用教程。

🧭 核心功能与适用场景

MicroBin 定位为个人或小团队的文件和文本分享工具,其核心优势在于体积小、资源占用低、配置灵活。它不仅仅是一个“粘贴板”,还集成了多种实用功能。

主要功能:

  • 文本与文件分享:支持上传文本(如代码片段)和文件(如图片、视频等)。
  • URL 缩短与重定向:可将长链接生成为短链接。
  • 端到端加密(E2EE):支持服务端和客户端加密,保障敏感信息安全。
  • 灵活的存储与数据库:支持 SQLite 和 JSON 两种数据库后端。
  • 强大的上传控制:可为每个上传设置公开/私密、可编辑/不可编辑、自动过期或永不过期。
  • 人性化标识符:使用“动物名称”(如 pig-dog-cat)而非随机数字作为上传链接的标识,更易读。
  • 原始内容服务:支持以原始格式(/raw/)提供文本或文件内容,方便脚本调用。
  • QR 码支持:为分享链接生成二维码。

适用场景:

  • 在不同设备间快速传输文本或文件。
  • 作为轻量级文件分享服务,替代大附件邮件或即时通讯软件。
  • 作为个人 URL 缩短服务。
  • 用于快速配置文件的 Web 托管(利用 /raw 功能)。

📦 部署方式

MicroBin 支持多种部署方式,其中最简便的是使用 Docker。它运行时仅需几 MB 内存和磁盘空间。

方式一:快速 Docker 安装(推荐)

项目提供了一个便捷的一键安装脚本:

1
bash <(curl -s https://microbin.eu/docker.sh)

此脚本会自动拉取 Docker 镜像并启动服务。完成后,MicroBin 默认运行在 http://localhost:8080

方式二:从 Cargo 手动安装(需 Rust 环境)

如果你已安装 Rust 工具链,可以通过 Cargo 安装:

1
2
3
4
5
6
7
8
9
# 1. 安装 MicroBin
cargo install microbin

# 2. 下载示例配置文件
curl -L -O https://raw.githubusercontent.com/szabodanika/microbin/master/.env

# 3. 加载环境变量并启动
source .env
microbin

方式三:使用预编译二进制文件

GitHub Releases 页面下载对应你操作系统的静态编译二进制文件,直接运行即可。

⚙️ 配置与管理

MicroBin 通过环境变量进行配置。你可以在启动前设置它们,或编辑 .env 文件。
常用配置项包括:

  • MICROBIN_PORT:服务监听端口(默认 8080)。
  • MICROBIN_ADDRESS:绑定地址(默认 127.0.0.1,对外服务需改为 0.0.0.0)。
  • MICROBIN_DATABASE:数据库类型,可选 sqlitejson
  • MICROBIN_ENCRYPTION_KEY:用于服务端加密的密钥(建议设置)。
  • MICROBIN_DEFAULT_EXPIRY:上传内容的默认过期时间。
  • MICROBIN_PRIVATE:是否默认将上传设置为私有(需要提供查看密钥)。

所有配置项及其说明可在项目的 .env 文件或官方文档中找到。

🚀 使用指南

  1. 访问 Web 界面:在浏览器中打开 http://你的服务器IP:8080
  2. 上传内容
    • 文本:在文本框中输入内容。
    • 文件:点击“选择文件”或拖拽文件到上传区。
    • 可以勾选“加密”、“私有”、“可编辑”等选项。
    • 点击“上传”按钮。
  3. 获取分享链接:上传成功后,页面会显示一个形如 http://server.com/file/pig-dog-cat 的链接。你可以复制它,或扫描生成的 QR 码进行分享。
  4. 查看原始内容:如果你上传的是文本或配置文件,可以通过 http://server.com/raw/pig-dog-cat 直接获取原始内容,方便其他脚本或应用调用。

❓ 常见问题与注意事项

  • 数据持久化:使用 Docker 时,请确保将容器内的 /app/data 目录挂载到宿主机卷,否则容器重启后数据会丢失。
  • 外部访问:需要将 MICROBIN_ADDRESS 设置为 0.0.0.0,并确保服务器的防火墙开放了对应端口(默认 8080)。
  • 安全提示:如果服务暴露在公网,强烈建议启用加密功能并设置管理密码(如适用),避免被滥用。
  • 性能:MicroBin 资源占用极低,甚至可以在树莓派等低功耗设备上顺畅运行。

总结

MicroBin 是一个极简、快速、功能完整的自托管分享工具对于个人或小团队,强烈推荐使用 Docker 一键安装方式,它能在几分钟内部署完成,几乎零配置即可开始使用。它的“动物名称”链接和灵活的权限控制,使其在易用性和功能性之间取得了很好的平衡,特别适合需要快速分享文本、文件或需要自建短链接服务的场景。如果你对代码感兴趣,其全部代码在 GitHub 上开源,采用 BSD 3-Clause 许可。