Jonline Docker镜像文档

镜像概述和主要用途

Jonline是一个联邦开源社区规模社交网络，采用Rust、React、Flutter构建，并结合gRPC和HTTP技术。本镜像在标准（非精简版）Debian服务器上运行Jonline，暴露Flutter Web应用（端口80、8000、443，当通过环境变量启用TLS时）和Jonline gRPC后端（端口27707）。

核心功能和特性

• 基于联邦架构的开源社交网络服务
• 支持Flutter Web应用多端口访问（80、8000、443）
• 内置gRPC后端服务（端口27707），支持gRPC反射
• 基于标准Debian构建，兼容Debian系统管理工具
• 通过环境变量灵活配置数据库、对象存储、TLS等关键参数
• 内置多种服务器管理工具和Jonline二进制程序

使用场景和适用范围

• 开发者本地搭建Jonline测试环境
• 社区组织部署私有或公共社交网络服务
• 需要联邦社交功能的小型社区平台构建

详细使用方法和配置说明

本地运行Jonline

Makefile管理的设置

如果系统安装了make、Docker以及提供createdb命令的Postgres（已加入PATH），最简单的方法是克隆GitHub仓库并使用Jonline的Makefile（注意使用backend/.env-example中的环境变量和backend/Makefile中的Make目标）：

bash
git clone ***:JonLatane/jonline.git
cd jonline

# 运行createdb jonline_dev，并在后台本地运行MinIO的Docker镜像
make local_db_create local_minio_create

# 启动Jonline最新镜像
docker run --rm --env-file=backend/.env-example \
    -p 27707:27707 -p 80:80 -p 8000:8000 -p 443:443 \
    jonlatane/jonline

完成后清理数据，只需执行make local_db_delete local_minio_delete。

Postgres设置

Postgres设置留给读者自行操作，因为其已有完善文档且因平台而异（Homebrew、apt等）。最终需创建数据库jonline_dev、用户db_user和密码secure_password，并满足：

• db_user能执行数据库迁移（可能需要以Postgres管理员身份执行ALTER USER db_user WITH SUPERUSER）
• Postgres允许来自Docker容器的db_user连接

MinIO设置

以下命令将在当前工作目录创建jonline-minio-data目录，并启动名为jonline-dev-minio的本地MinIO（S3兼容对象存储服务）：

bash
mkdir jonline-minio-data
docker run -d -p 9000:9000 -p 9090:9090 --name jonline-dev-minio \
   -v $(pwd)/jonline-minio-data:/data \
   -e "MINIO_ROOT_USER=ROOTNAME" \
   -e "MINIO_ROOT_PASSWORD=CHANGEME123" \
   minio/minio server /data --console-address ":9090"

可通过http://localhost:9090访问MinIO控制台。

本地运行Jonline

以下命令将针对已配置的Postgres和MinIO启动最新Jonline镜像：

bash
docker run --rm -e DATABASE_URL=postgres://db_user:***/jonline_dev \
   -e MINIO_ENDPOINT=[***] \
   -e MINIO_REGION= \
   -e MINIO_BUCKET=jonline-dev \
   -e MINIO_ACCESS_KEY=ROOTNAME \
   -e MINIO_SECRET_KEY=CHANGEME123 \
    -p 27707:27707 -p 80:80 -p 8000:8000 -p 443:443 \
    jonlatane/jonline

环境变量

Jonline通过环境变量提供配置参数（包括密钥）：

• DATABASE_URL：Jonline连接的Postgres数据库URL（包含凭据）。
• MINIO_ENDPOINT、MINIO_REGION、MINIO_BUCKET、MINIO_ACCESS_KEY、MINIO_SECRET_KEY：Amazon S3/MinIO兼容对象存储的凭据。目前MinIO是必需的，未来可能会变为可选。
• TLS_KEY、TLS_CERT：TLS密钥和证书。若未提供，Jonline不会启动安全服务器；若无效，Jonline会记录错误但仍在其他端口运行非安全服务器。若证书有效，端口80和8000的Web服务器会将请求从[***][:8000]/path/to转发至[***]。
  • 有关HTTPS/TLS设置的详细说明，参见GitHub上的generated_certs/README.md，支持通过Cert-Manager（推荐）、其他CA或自定义CA配置，适用于支持K8s Load***、DNS管理API和Cert-Manager的云服务（如Google Cloud、AWS、Azure、DigitalOcean、Scaleway等）。
• CA_CERT（仅高级用户，用于自定义CA和/或双向TLS设置）：Jonline后端的CA证书，用于自行在gRPC服务上设置双向TLS（注意：端口443的安全Web服务器不支持自定义CA，在此配置下可能崩溃，但Tonic/gRPC Jonline后端仍可运行）。

通过bash管理服务器

连接服务器

通过Docker连接

1. 从docker container ls获取运行Jonline的容器ID。
2. 执行docker exec -it <ContainerID> bash打开bash。

通过Kubernetes连接

• 若使用Jonline基于Makefile的K8s部署系统，从Jonline仓库目录执行cd deploys，然后运行make deploy_be_shell（若命名空间非默认的jonline，可使用NAMESPACE=my-namespace deploy_be_shell）。
• 否则，参见deploys/Makefile中deploy_be_shell目标对应的kubectl命令。

部署管理

环境和系统工具

Jonline基于Debian镜像构建，因此可轻松安装和使用Debian服务器管理工具：

• 例如，检查CPU使用率：apt install htop && htop。
  • 镜像中已预装的非Debian基础软件包包括curl、psql和grpcurl。
• 查看DATABASE_URL密钥：echo $DATABASE_URL。
  • 测试数据库连接：psql $DATABASE_URL。
• 使用grpcurl测试Jonline服务器：./opt/grpcurl（例如./opt/grpcurl jonline.io:27707 list）。

Jonline工具

Jonline工具位于/opt目录，依赖DATABASE_URL密钥，服务器正常运行时即可使用：

• 为用户分配管理员角色：./opt/set_permission my_username admin on
  • 可将admin替换为Jonline协议文档中定义的任何权限（不区分大小写）。
• 删除过期的身份验证令牌：./opt/delete_expired_tokens
  • 标准Jonline K8s部署通过CronJob自动执行此操作，无需手动运行。
• 删除预览图片：./opt/delete_preview_images
  • 标准Jonline K8s部署通过CronJob生成预览图片，删除后会重新生成。
  • 注意：此镜像本身无法生成预览截图，因此/opt/generate_preview_images二进制文件不可用。由于Chromium Headless体积较大，提供了单独的jonline_preview_generator镜像。若需在主服务器上安装Chromium Headless并使用此二进制文件，可执行Jonline仓库中deploys/docker/preview_generator/Dockerfile内的命令。

端口说明

Jonline暴露以下端口：

• 27707：Jonline协议端口，提供gRPC服务（支持Web和/或TLS）及gRPC反射服务。
• 443：当TLS_KEY和TLS_CERT有效时，启动安全HTTPS服务器，提供Tamagui（默认）或Flutter UI。
• 80和8000：非安全HTTPS服务器。当TLS_KEY和TLS_CERT有效时，重定向至端口443的HTTPS服务器；否则直接提供Tamagui（默认）或Flutter UI。

内置Jonline二进制程序

• /opt/jonline：Jonline主服务器（容器入口点）
• /opt/delete_expired_tokens：删除过期刷新令牌和身份验证令牌的任务
• /opt/delete_preview_images：删除Jonline预览图片的一次性任务（通常用于让jonline_preview_generator重新生成）