prologic/yarnd

Yarn.social

概述和主要用途

Yarn.social 是一个自托管、类 *** 的去中心化微博客平台。无广告、无跟踪，内容和数据完全由用户掌控！

• yarnd 是 Yarn.social 节点后端服务器
• yarnc 是 yarnd API 的命令行客户端，同时支持 Twtxt 协议交互

核心功能和特性

• 去中心化架构：无需依赖中心化服务，支持个人或组织自行部署节点（pod）
• 隐私优先设计：无广告、无用户行为跟踪，数据存储在用户自有服务器
• 多客户端支持：提供 Web 界面和命令行客户端（yarnc），满足不同使用场景
• 媒体支持：集成媒体上传功能（需 FFmpeg 支持）
• 可定制配置：支持开放注册/个人资料、动态长度限制、缓存策略等精细化设置
• 容器化部署：提供 Docker 镜像和 Docker Compose/Swarm 配置，简化部署流程

使用场景和适用范围

• 个人用户搭建私有社交媒体平台，保护数据隐私
• 小型社区或组织部署内部交流网络
• 对现有社交媒体平台隐私政策不满，寻求替代方案的用户
• 技术爱好者构建去中心化网络生态

详细使用方法和配置说明

安装方式

预编译二进制文件（暂不推荐）

注意：在 Issue #250 解决前，建议优先使用 Docker 镜像或从源码构建。

可从 Releases 页面获取预编译二进制文件。

使用 Homebrew（macOS）

console
# 添加 Homebrew 仓库
brew tap yarnsocial/yarn https://git.mills.io/yarnsocial/homebrew-yarn.git
# 安装（包含 yarnd 服务器和 yarnc 客户端）
brew install yarn

启动服务器：

console
yarnd

运行命令行客户端：

console
yarn

从源码构建（需 Go 开发环境）

1. 克隆仓库：

console
git clone https://git.mills.io/yarnsocial/yarn.git

2. 安装依赖：

   • Linux/macOS：

   console
   make deps
   

   媒体上传功能需安装 FFmpeg 及其开发包（如 ffmpeg-dev），具体名称参考系统软件仓库。

   • FreeBSD：

   console
   # 安装必要工具
   pkg install gmake pkgconf
   # 安装依赖
   gmake deps
   

3. 构建二进制文件：

   • Linux/macOS：make
   • FreeBSD：gmake

基本使用

命令行客户端（yarnc）

1. 登录节点：

$ ./yarn login
INFO[0000] 使用配置文件: /Users/prologic/.twt.yaml
用户名:

2. 查看时间线：

$ ./yarn timeline
INFO[0000] 使用配置文件: /Users/prologic/.twt.yaml
> prologic (50 分钟前)
Hey @rosaelefanten 👋 很高兴看到你有 Twtxt 动态！看到了你的 [推文](https://twitter.com/koehr_in/status/1326914925348982784?s=20)（我猜是你的？）。之前从没听说过 `aria2c`！🤣 今日新发现

> dilbert (2 小时前)
愤怒的技术作家 ‣ https://dilbert.com/strip/2020-11-14

3. 发布动态：

$ ./yarn post
INFO[0000] 使用配置文件: /Users/prologic/.twt.yaml
测试 `yarn` 命令行客户端
INFO[0015] 发布动态中...
INFO[0016] 发布成功

4. 查看帮助：

console
yarnc help

使用 Docker Compose 快速部署

1. 准备 docker-compose.yml（官方镜像）
2. 启动服务：

console
docker-compose up -d

3. 访问 Web 界面：http://localhost:8000/

Web 应用启动

直接运行后端服务器 yarnd（默认禁用注册，需手动启用）：

console
# 启用注册并启动
yarnd -R

访问：http://localhost:8000/

核心配置选项

通过命令行参数或环境变量配置节点，关键选项如下：

安全配置（必须设置）： 生成 64 位随机密钥（API 签名、Cookie 加密等）：

console
cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 64 | head -n 1

通过环境变量设置：

bash
export API_SIGNING_KEY="生成的密钥"
export COOKIE_SECRET="生成的密钥"
export MAGICLINK_SECRET="生成的密钥"

生产环境部署（Docker Swarm）

1. 确保集群已安装 Traefik 负载均衡器
2. 使用官方 yarn.yaml Stack 文件部署：

console
docker stack deploy -c yarn.yml

贡献与支持

• 提交 Issue：报告错误/功能建议
• 代码贡献：提交 PR 至官方仓库，参考 贡献指南
• 开发者文档：dev.twtxt.net

许可证

采用 MIT 许可证