本分支 (custom) 是基于原版 main 分支的改进版本，新增了多项实用功能和优化。

💡 特别提醒

本分支为 个人自用定制版本。在保持与原版核心功能同步的同时，会根据个人需求添加一些可能违背原版“极简/设计初衷”的功能。

请在选择前明确您的需求：

1. 优先推荐原版：如果您追求最纯粹的 Ech0 体验，请优先选择 原版。
2. 按需使用：仅在您确实需要本分支提供的特定功能（如视频支持、Live Photo 等）时才考虑使用。
3. 随时切回：本分支提供了便捷的双向切换/数据同步方案，您可以随时无损切回原版。
4. 同步策略：本分支会第一时间跟进上游更新。若自定义逻辑与上游代码冲突，将优先保留上游逻辑。
5. 性能损耗声明：为了确保与原版的兼容性以及同步便利，代码中包含了一些额外的兼容逻辑（如针对旧版数据库表的同步方案），这可能会带来极其微小的性能开销。如果您对性能有极致追求，请知悉并慎重选择。

docker run -d \
  --name ech0 \
  -p 6277:6277 \
  -v /opt/ech0/data:/app/data \
  -v /opt/ech0/backup:/app/backup \
  -e JWT_SECRET="Hello Echos" \
  lumlime/ech0:latest

部署后访问 http://ip:6277 即可使用 • 详细部署说明 • 原版迁移指南

docker run -d \
  --name ech0 \
  -p 6277:6277 \
  -v /opt/ech0/data:/app/data \
  -v /opt/ech0/backup:/app/backup \
  -e JWT_SECRET="Hello Echos" \
  lumlime/ech0:latest

# 停止当前的容器
docker stop ech0

# 移除容器
docker rm ech0

# 拉取最新的镜像
docker pull lumlime/ech0:latest

# 启动新版本的容器
docker run -d \
  --name ech0 \
  -p 6277:6277 \
  -v /opt/ech0/data:/app/data \
  -v /opt/ech0/backup:/app/backup \
  -e JWT_SECRET="Hello Echos" \
  lumlime/ech0:latest

预览地址 | 官网与文档 | Ech0 Hub

Ech0

面向个人的新一代开源、自托管、专注思想流动的轻量级联邦发布平台。

Ech0 是一款专为个人用户设计的新一代开源自托管平台，低成本、超轻量，支持 ActivityPub 协议，让你轻松发布和分享想法、文字与链接。简洁直观的界面结合高效的命令行工具，让内容管理变得简单而自由。你的数据完全自主可控，随时随地与世界联通，构建属于你的思想网络。

☁️ 原子级轻量：内存占用不到15MB，镜像大小不到50MB,单SQLite文件存储架构
🚀 极速部署：无需配置，从安装到使用只需1条命令
✍️ 零干扰写作：纯净的在线Markdown编辑器，支持丰富的Markdown插件与预览
📦 数据主权：所有内容存储于本地SQLite文件，支持RSS订阅
🔐 安全备份机制：支持Web、TUI、CLI三种模式下一键导出、备份完整数据,支持后台自动备份
♻️ 无感恢复支持：支持TUI/CLI快照恢复与Web面板在线零停机恢复机制，保障数据安全无忧
🎉 永久免费：AGPL-3.0协议开源，无追踪/无订阅/无服务依赖
🌍 跨端适配：完美兼容桌面/移动浏览器，支持手机、iPad、PC三端响应式布局
👾 PWA适配：支持作为Web应用安装，体验更接近原生
🏷️ 优雅的标签管理与过滤：智能标签系统、快速过滤与精准检索，让信息组织更高效、更直观
☁️ S3 存储集成 —— 原生适配 S3 兼容对象存储，轻松实现云端高效存储
🌐 ActivityPub 联邦 —— 与 Mastodon、Misskey 等平台互联共通，构建去中心化生态
🔑 OAuth2和OIDC 身份认证 —— 原生支持 OAuth2 协议，轻松接入第三方登录与 API 授权
🙈 Passkey 无密码登录：支持基于生物识别/硬件密钥的 Passkey 登录方式，显著提升安全性与登录体验
📝 内置Todo管理：轻松记录、管理每日待办事项，帮助你高效规划和追踪任务进度
🧘 安静的收件箱模式：默认减少系统级打扰，信息按需呈现，回归工具“辅助而不干扰”的本质
🪶 高可用 Webhook：支持与外部系统进行实时扩展与协作，实现事件驱动的自动化工作流
🌗 深色模式与主题扩展：支持自适应系统或自由切换 Dark Mode，支持后期扩展自定义配色
🤖 快捷配置启动 Agent AI：快捷配置多种大语言模型，无需动手折腾即可体验 AI
🧰 命令行利器：内置高可用 CLI 工具，为开发者与高级用户提供极致掌控力与自动化体验
🔑 快捷访问令牌管理：支持生成与一键吊销访问令牌，安全高效地完成 API 调用与第三方集成
📊 实时系统资源监控面板：基于 WebSocket 的高性能监控模块，让你对运行状态一目了然
📟 极致 TUI 支持：面向终端用户打造的友好交互界面，轻松对Ech0进行管理
🔗 Ech0 Connect：全新多实例互联功能，实现Ech0实例间状态订阅与跟踪
🎵 无缝音乐集成: 内置超低资源占用的音乐播放器，提供沉浸式背景音乐与专注模式
🎥 即时视频分享: 原生支持哔哩哔哩/YouTube视频智能解析
🃏 丰富的快捷卡片：支持网站链接、GitHub项目等多种富媒体内容一键分享，让信息展示更加直观生动
⚙️ 高级自定义功能：为高级用户提供便捷自定义样式与脚本，分享更具表现力
💬 评论系统：支持快捷接入Twikoo评论服务，轻量、快捷、无侵入，为你的内容带来即时互动与反馈
💻 跨平台兼容：原生支持 Windows、Linux 以及树莓派等 ARM 架构设备，确保多样化部署场景下稳定运行
🔗 Ech0 Hub 广场：内置 Ech0 Hub 广场，轻松发现、订阅和共享优质内容
📦 二进制自包含：集成完整资源，无需额外安装依赖或配置，极大简化部署流程
🔗 丰富的 API 支持: 提供开放 API，方便与其他系统集成，实现更灵活的应用场景
🃏 内容展示支持：支持类 X（Twitter）风格卡片展示，同时支持点赞分享等社交互动
👤 多账户权限管理：支持多账户体系，提供灵活的权限控制，保障内容和功能访问的安全性与私密性

docker run -d \
  --name ech0 \
  -p 6277:6277 \
  -v /opt/ech0/data:/app/data \
  -v /opt/ech0/backup:/app/backup \
  -e JWT_SECRET="Hello Echos" \
  sn0wl1n/ech0:latest

💡 部署完成后访问 ip:6277 即可使用
🚷 建议把-e JWT_SECRET="Hello Echos"里的Hello Echos改成别的内容以提高安全性
📍 首次使用注册的账号会被设置为管理员（目前仅管理员支持发布内容）
🎈 数据存储在/opt/ech0/data下

创建一个新目录并将 docker-compose.yml 文件放入其中

在该目录下执行以下命令启动服务：

docker-compose up -d

如果你希望在 Kubernetes 集群中部署 Ech0，可以使用项目提供的 Helm Chart。

由于本项目暂时未提供在线 Helm 仓库，你需要先将代码库克隆到本地，然后从本地目录进行安装。

1. 克隆代码库:

   git clone https://github.com/lin-snow/Ech0.git
   cd Ech0

2. 使用 Helm 安装:

   # helm install <发布名称> <chart目录>
   helm install ech0 ./charts/ech0

   你也可以自定义发布名称和命名空间：

   helm install my-ech0 ./charts/ech0 --namespace my-namespace --create-namespace

# 停止当前的容器
docker stop ech0

# 移除容器
docker rm ech0

# 拉取最新的镜像
docker pull sn0wl1n/ech0:latest

# 启动新版本的容器
docker run -d \
  --name ech0 \
  -p 6277:6277 \
  -v /opt/ech0/data:/app/data \
  -v /opt/ech0/backup:/app/backup \
  -e JWT_SECRET="Hello Echos" \
  sn0wl1n/ech0:latest

# 进入 compose 文件目录
cd /path/to/compose

# 拉取最新镜像并重启
docker-compose pull && \
docker-compose up -d --force-recreate

# 清理旧镜像
docker image prune -f

1. 更新代码库: 进入本地的 Ech0 代码库目录，并拉取最新的代码。

   cd Ech0
   git pull

2. 更新 Helm Release: 使用 helm upgrade 命令更新你的发布版本。

   # helm upgrade <发布名称> <chart目录>
   helm upgrade ech0 ./charts/ech0

   如果你使用了自定义的发布名称和命名空间，请使用对应的名称：

   helm upgrade my-ech0 ./charts/ech0 --namespace my-namespace

1. Ech0是什么？ Ech0 是一款轻量级的开源自托管平台，专为快速发布与分享个人想法、文字和链接而设计。它提供简洁的界面，支持零干扰的写作体验，所有数据存储于本地，确保用户对内容的完全控制。

2. Ech0不是什么？ Ech0不是传统的笔记软件，设计之初并不是为了专业的笔记管理和记录（如Obsidian、Notion等），Ech0的核心功能类似朋友圈/说说。

3. Ech0 是免费的吗？ 是的，Ech0 完全免费且开源，遵循 AGPL-3.0 协议。它没有广告、追踪、订阅或服务依赖。

4. 如何进行备份和恢复数据？ 由于所有内容都存储在本地 SQLite 文件中，您只需备份/opt/ech0/data目录中的文件即可（具体选择部署时的映射路径）。在需要恢复时，直接将备份文件还原即可，当然也可以使用在线数据管理，直接在设置-数据管理选项内使用创建、导出、恢复快照等功能即可快速管理数据。若恢复成功后数据依然没有显示最新内容，可以手动重启一下Docker容器即可！

5. Ech0 支持 RSS 吗？ 是的，Ech0 支持 RSS 订阅，您可以通过 RSS 阅读器订阅您的内容更新。

6. 为什么发布失败，提示联系管理员？ 当前版本设计上，只有管理员可以发布内容。部署后，首个注册的用户会自动被设置为系统管理员，其他用户无法发布内容（可在设置中分配权限）。

7. 为什么没有明确的权限划分？ Ech0 旨在保持简洁和轻量，因此在设计时没有复杂的权限系统。我们希望用户能够专注于分享内容，而不是被复杂的权限管理所困扰。为了保持流畅的使用体验，Ech0 尽量精简了功能，避免不必要的复杂性。（因此目前只有管理员与非管理员之分，所以请谨慎分配你的权限）。

8. 为什么别人无法显示自己的Connect头像？ 要使别人显示自己的Connect头像需要在系统设置-服务地址中填入自己当前的实例地址，比如我自己填的是部署ech0后的域名https://memo.vaaat.com(注意：这里填的链接需要带上http或https)。

9. 设置中的MetingAPI项是什么？ 这是用于解析获取音乐流媒体直链的服务api,用于分享的音乐卡片功能，如果不设置则默认使用ech0提供的api（部署于vercel）。

10. 为什么添加后的Connect只显示了一部分？ 因为后端会尝试获取所有connect的实例信息，如果某个实例挂了或者无法访问则会被抛弃，只返回获取到的有效connect实例的信息给前端。

11. Ech0不建议发什么？ Ech0发布的内容分为三部分：文字、图片、扩展内容（如音乐、视频等播放器卡片），Ech0不建议发布同时包含文字 + 图片 + 扩展内容这种密集内容，因为其违反了Ech0的一些设计理念，同时在任何时候都不推荐发布扩展内容或长篇幅的文章。

12. 如何开启评论功能？ 在设置页面的评论API项中填入你部署后的Twikoo后端地址后自动开启，当前仅支持Twikoo

13. S3 存储如何配置？ 在存储设置页面填入所需配置信息，注意：endpoint不需要填http或者https开头，存储桶需提供公共访问权限。

14. 如何加入联邦宇宙？ 需要将Ech0绑定一个域名，并在设置界面的服务器地址填写域名即可自动加入联邦宇宙，填写示例如下：https://memo.vaaat.com

• 若程序出现 bug，可在 Issues 中反馈。
• 针对新增或改进的需求，欢迎前往 Discussions 一起交流。
• 官方 QQ 群号：1065435773

官方QQ交流群	其它交流群
	暂无

• 贡献指南
• 行为准则
• 安全策略
• 许可证

by ExcaliDraw

📌 Go 1.25.3+

📌 C 编译器 使用 go-sqlite3 等需要 CGO 的库时，需安装：

• Windows：
  • MinGW-w64
  • 解压后将bin目录添加到PATH
• macOS： brew install gcc
• Linux： sudo apt install build-essential

📌 Google Wire 安装wire用于依赖注入文件生成:

• go install github.com/google/wire/cmd/wire@latest

📌 Golangci-Lint 安装Golangci-Lint用于lint和fmt:

• 在项目根目录下执行golangci-lint run进行lint
• 在项目根目录下执行golangci-lint fmt进行格式化

📌 Air（后端热重载，可选）

• 推荐通过 Makefile 安装：make air-install
• 或手动安装：go install github.com/air-verse/air@latest

📌 Swagger 安装Swagger用于生成和使用符合OpenAPI规范的接口文档

• 在项目根目录下执行swag init -g internal/server/server.go -o internal/swagger后生成或更新swagger文档
• 打开浏览器访问http://localhost:6277/swagger/index.html查看和使用swagger文档

📌 NodeJS v25.5.0+, PNPM v10.30.0+

注：如需要多个nodejs版本共存可使用fnm进行管理

第一步： 后端（在 Ech0 根目录下）：

make run # 普通启动后端（等价于 go run main.go web）

make dev # 使用 Air 启动后端热重载

如果依赖注入关系发生了变化先需要在ech0/internal/di/下执行wire命令生成新的wire_gen.go文件

第二步： 前端（新终端）：

cd web # 进入前端目录

pnpm install # 如果没有安装依赖则执行

pnpm dev # 启动前端预览
# 或在项目根目录执行：make web-dev

第三步： 前后端启动后访问： 前端预览： http://localhost:5173 （端口在启动后可在控制台查看）
后端预览： http://localhost:6277 （默认后端端口为6277）

对使用层次化架构的包进行导入时，请使用规范的 alias 命名：
model 层： xxxModel
util 层： xxxUtil
handler 层： xxxHandler
service 层： xxxService
repository 层： xxxRepository

感谢所有为项目充电的朋友！你们的支持让项目持续发光发热 💡✨

• 感谢广大用户提供的各种改进建议和问题反馈
• 感谢所有开源社区的贡献者与支持者

🌟 如果你觉得 Ech0 不错，欢迎为项目点个 Star！🚀

Ech0 完全开源且免费，持续维护和优化离不开大家的支持。如果这个项目对你有所帮助，也欢迎通过赞助支持项目的持续发展。你的每一份鼓励和支持，都是我们前进的动力！ 你可以向打赏二维码付款，然后备注你的github名称，将在首页 README.md 页面向所有展示你的贡献

支持平台	二维码
爱发电

███████╗     ██████╗    ██╗  ██╗     ██████╗
██╔════╝    ██╔════╝    ██║  ██║    ██╔═████╗
█████╗      ██║         ███████║    ██║██╔██║
██╔══╝      ██║         ██╔══██║    ████╔╝██║
███████╗    ╚██████╗    ██║  ██║    ╚██████╔╝
╚══════╝     ╚═════╝    ╚═╝  ╚═╝     ╚═════╝