ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

Athens RTC 服务器部署方案:基于 Docker Compose、Nginx 反向代理与卷持久化的架构决策(ADR-0009)

Athens RTC 服务器部署方案:基于 Docker Compose、Nginx 反向代理与卷持久化的架构决策(ADR-0009) 前端桌面应用数据库后端【免费下载链接】athensAthens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21项目地址https://gitcode.com/gh_mirrors/at/athens点击查看免费下载导读本文以 Athens 项目 doc/adr/0009-rtc-deployment.md 中的架构决策记录ADR-0009为核心完整还原该决策从问题背景、约束权衡到最终结论的推导过程并结合仓库中的 docker-compose.yml、nginx.conf、athens.dockerfile 等真实部署产物进行源码级印证。读完本文你将掌握 Athens RTC实时协作服务器的安装、更新与数据韧性三层核心诉求理解输入用 Docker Compose、输出用 Volume这一部署哲学的由来并能直接复刻一套由 Athens 服务、Nginx 代理、Fluree 账本组成的容器化部署栈。一、ADR-0009 背景RTC 服务器就绪之后部署问题浮出水面2021-08-24 提出的 ADR-0009状态为Proposed解决的是一个很实际的问题Athens 已经拥有可构建的 RTC 服务器实时协作服务器使多个客户端能够共享同一个知识图谱但如何把它部署起来供人使用还没有定义。决策记录的开篇即明确了三项核心需求安装installation提供一套可落地的部署方式更新update服务器升级时能够安全地执行迁移与启停流程数据韧性data resilience保证数据不会因升级、崩溃或存储介质问题而丢失。这三项诉求构成了 ADR 全文的骨架仓库中的部署工件也恰好围绕它们展开docker-compose.yml负责安装编排启动脚本与配置加载逻辑涉及更新流程卷volume与持久化路径的设计则直接服务于数据韧性。二、安装策略Docker Compose 作为统一输入机制2.1 决策Docker Compose 定义 Nginx 代理ADR-0009 的最终决策非常简洁我们将为 Athens 服务器创建一个 Docker Compose 定义并附带一个 Nginx 代理。该 Compose 定义中包含对 Athens 部署输出outputs的卷映射。这句话包含两层设计意图Docker Compose 是输入机制用户通过一个docker-compose.yml声明服务、镜像、端口、依赖关系与健康检查即可拉起整个 Athens 服务器Volume 是输出机制所有需要落盘的数据日志、DataScript 持久化、Fluree 账本统一通过卷映射暴露给宿主备份、快照、迁移都围绕这些卷展开。2.2 决策前讨论过的备选路径在做出上述决策之前ADR 记录了对安装形态的多种考量这些内容至今仍有参考价值考量点讨论内容主机名配置允许配置 hostname端口本就可配置。若随镜像附带 Nginx则无需再单独配置主机名镜像打包理想情况下所有服务捆绑进一个 Docker 镜像无论 Compose 里有多少服务备份等产物都要输出到某个卷数据安全程度只取决于该卷Electron 复用服务器方案同样可用于 Electron 客户端的 PKM个人知识管理场景因此存储方案需要具备通用性一键部署理想情况下支持在 AWS/DO/GCP 上一键部署Docker 策略天然满足这一要求值得注意的是第 3 点与第 4 点是 Docker Compose 方案被选中的关键理由存储方案通用使服务器与桌面端可以共享同一套持久化设计Docker 的可移植性使公有云一键部署成为可能。从源码看docker-compose.yml 中的服务定义athens / nginx / fluree与 config.default.edn 中的默认配置http.port 3010、fluree.servers http://fluree:8090、datascript.persist-base-path /srv/athens/datascript/persist/相互印证——镜像内路径与 Compose 卷挂载路径、服务名与默认 Fluree 地址完全对齐。2.3 完整部署工件docker-compose.yml 逐段解析仓库根目录的 docker-compose.yml 是 ADR-0009 决策的直接产物包含三个服务服务一athens核心服务器athens: image: ghcr.io/athensresearch/athens:latest restart: always depends_on: fluree: condition: service_healthy ports: - 3010:3010 # Change this according to CONFIG_EDN. volumes: - ./athens-data/logs:/srv/athens/logs - ./athens-data/datascript:/srv/athens/datascript environment: - CONFIG_EDN${CONFIG_EDN:-{}} healthcheck: test: curl -f localhost:3010/health-check interval: 15s timeout: 60s retries: 10 start_period: 15s要点解读镜像标签文件头注释明确要求始终使用不可变标签immutable tags不要用latest等可变标签latest会在 Athens 发布时被替换为发布版本号。这是为了避免拉取到意外变更的镜像导致部署环境漂移。本地构建开关build段落默认被注释如需本地构建可取消注释context: .dockerfile: athens.dockerfile。注释中还记录了一个实操坑在 M1 Mac 上本地构建时Athens 镜像连接 Fluree 似乎会无故挂起但若移除script/docker-run-lan-party.sh中的所有内存标志则不再挂起——这可能是 Docker on M1 的问题。依赖顺序depends_oncondition: service_healthy确保 Athens 只在 Fluree 通过健康检查后才启动。端口映射3010:3010与 config.default.edn 中的:http {:port 3010}对应默认配置还允许通过CONFIG_EDN覆盖端口因此注释提示按 CONFIG_EDN 修改。卷映射./athens-data/logs挂载到/srv/athens/logsJVM 崩溃日志与堆转储输出目录./athens-data/datascript挂载到/srv/athens/datascriptDataScript 持久化目录见 config.default.edn 的:datascript {:persist-base-path /srv/athens/datascript/persist/}。配置注入CONFIG_EDN${CONFIG_EDN:-{}}通过环境变量向容器传入 EDN 格式配置默认空对象。配置的合并逻辑在 components/config.clj 中实现加载打包在镜像内的config.default.edn作为默认值再通过config.core读取环境变量并深合并merge-maps。健康检查容器每 15 秒curl一次localhost:3010/health-check。该端点定义在 components/web.clj 中是一个返回200与ok的简单 GET 路由。服务二nginx反向代理与 WebSocket 升级nginx: image: ghcr.io/athensresearch/nginx:latest restart: always depends_on: athens: condition: service_healthy ports: - 80:80Nginx 容器等待 Athens 健康检查通过后启动监听宿主 80 端口将外部流量转发给 Athens 的 3010 端口。服务三fluree账本 / 事件存储fluree: image: fluree/ledger:1.0.0-beta17 restart: always ports: - 8090:8090 volumes: - ./athens-data/fluree:/var/lib/fluree healthcheck: test: curl -f localhost:8090/fdb/health interval: 15s timeout: 30s retries: 3 start_period: 15s要点解读事件大小上限注释说明默认设置下 Fluree 最大推荐事件大小为2MB可通过fdb-memory-reindex-max提升到10MB——这直接呼应 ADR 中存储机制存在上限需按用例与 UX 设定上传限制的讨论。版本固定镜像锁定为fluree/ledger:1.0.0-beta17与 Compose 头部始终使用不可变标签的规范一致。健康检查的已知问题注释TODO明确警告1.0.0-beta17之后的新版 Fluree 镜像不再包含curl改用更小的基础镜像因此该健康检查在升级后可能失效需要另寻方案届时也可顺势换用更小的 JDK 容器。2.4 镜像内部athens.dockerfile 与启动脚本athens.dockerfile 以openjdk:16为基础镜像FROM openjdk:16 RUN mkdir -p /srv/athens/db COPY target/athens-lan-party-standalone.jar /srv/athens/ COPY script/docker-run-lan-party.sh /srv/athens/ WORKDIR /srv/athens/ EXPOSE 3010 CMD [/srv/athens/docker-run-lan-party.sh]它把 uberjarathens-lan-party-standalone.jar与启动脚本复制进镜像工作目录设为/srv/athens/暴露 3010 端口容器入口即启动脚本。启动脚本 script/docker-run-lan-party.sh 则展示了 JVM 层面对进程稳定性与数据可诊断性的投入#!/bin/sh java -Xms512m -Xmx2560m -verbose:gc -XX:-UseParallelGC \ -XX:OnOutOfMemoryErrorkill -9 %p -XX:HeapDumpOnOutOfMemoryError \ -XX:HeapDumpPath/srv/athens/logs/ \ -XX:ErrorFile/srv/athens/logs/java_athens_hs_err_pid%p.log \ -jar athens-lan-party-standalone.jar-Xms512m -Xmx2560m堆初始 512MB、上限 2.5GB-XX:OnOutOfMemoryErrorkill -9 %pOOM 时直接强杀进程配合 Docker 的restart: always实现自动重启-XX:HeapDumpOnOutOfMemoryError与-XX:HeapDumpPath/srv/athens/logs/OOM 堆转储写入卷挂载的日志目录-XX:ErrorFile/srv/athens/logs/java_athens_hs_err_pid%p.logJVM 致命错误日志同样落盘。这些路径与 Compose 中./athens-data/logs:/srv/athens/logs的卷映射一一对应保证故障现场可以被宿主侧采集。三、更新流程启动/关闭序列与数据一致性3.1 ADR 对更新的要求ADR-0009 在更新update一节提出了服务器升级时的硬性要求更新必须运行引导序列boot sequence期间可以执行迁移migrations极可能需要关闭序列shutdown sequence——原因写在文档里Alex 在文件系统上两次观察到 DataHike 数据损坏Filipe 也观察到一次应当使用component即 Stuart Sierra 的 com.stuartsierra.component 生命周期库同时管理 boot 与 shutdown 序列并通过信号处理signal handling触发核心理想能否保证服务器输出始终一致如果 boot/shutdown 即使被打断也能保持输出一致那么即便中断也可以启动新的运行时——这是恢复的圣杯holy grail of recovery但即便如此仍然存在发往其他服务的、无法拦截的在途消息。3.2 源码印证component 生命周期与迁移能力仓库实现完全采用了component生命周期管理。自托管入口 core.clj 构建了一个标准的 component system(component/system-map :config (cfg/new-config) :fluree (component/using (fluree/new-fluree) [:config]) :datascript (component/using (datascript/new-datascript) [:config :fluree]) :webserver (component/using (web/new-web-server) [:config :datascript :fluree]) :nrepl (component/using (nrepl/new-nrepl-server) [:config]))-main通过(alter-var-root #system component/start)启动全部组件每个组件都实现component/Lifecycle的start/stop——例如 components/config.clj 在start时加载并深合并配置、在stop时清空配置components/web.clj 的stop会以 100ms 超时关闭 http-kit 服务器。这正是 ADR 所说的用 component 同时管理 boot 与 shutdown 序列。迁移能力由通用模块提供src/cljc/athens/common/migrations.cljc是 Athens 的迁移基础设施被 self-hosted 后端复用事件日志迁移测试见 test/athens/self_hosted/event_log_migrations_test.clj。由于 ADR-0009 状态仍为Proposed信号处理SIGTERM/SIGINT触发 shutdown 序列的具体实现尚未落地这是该决策尚未闭环的部分——可以在athens.self-hosted命名空间下追踪component/stop的调用点来持续观察进展。四、数据韧性多层持久化与 DataHike 损坏的历史教训4.1 ADR 定义的持久化层级ADR-0009 明确指出 Athens 场景存在多层持久化每一层都是数据安全的一个环节Athens 客户端保存到 Athens 服务器网络层写入Athens 服务器数据库提交变更事件日志 / 账本写入该数据库向其自身持久化层提交DataScript → 文件、Fluree → 自身存储持久化层如何变得真正耐久卷、快照、备份策略。这种分层视角直接决定了部署形态Docker Compose 只负责把各层串起来最终耐久性由卷之上的外部策略快照、异地备份决定——正如 ADR 结论所说数据韧性只取决于用户能把卷做得有多安全。4.2 源码印证DataScript 持久化与事件回放数据韧性在实现层的体现集中在 components/datascript.clj。组件启动时的流程清晰地展示了以事件日志为真相源、以持久化快照为加速点的恢复模型读取配置中的:datascript :persist-base-path若存在持久化路径通过persistence/load载入已持久化的 DataScript db 及对应事件 id重置连接后按事件 id 增量拉取 Fluree 中的事件日志:since-event-id**惰性回放lazily replay**所有事件到 DataScript 连接中——代码注释特别提醒不要持有惰性事件序列的引用否则无法逐条 GC、会全部驻留内存回放过程中按节流规则调用persistence/throttled-save!将 DataScript db 持久化到卷目录对应./athens-data/datascript卷。这个模型的含义正是 ADR 讨论的快照 vs 频繁写入权衡DataScript 文件持久化是低频快照Fluree 事件日志是高频写入。只要 Fluree 事件完整即使 DataScript 快照损坏重启后也能从事件流重建数据库。这是 Athens 数据韧性架构的核心机制。4.3 DataHike 损坏的已知问题与应对ADR-0009 记录了团队在 DataHike 文件系统存储上遇到的真实问题Alex 两次、Filipe 一次观察到数据损坏报错形如No implementation of method: :-affects-key of protocol: #hitchhiker.tree.op/IOperation found for class: incognito.base.IncognitoTaggedLiteral当时的唯一解决办法是删除文件系统数据。ADR 给出的后续动作是需要复现repro该问题以指导关于数据丢失与服务器更新的决策应向 DataHike 社区求证在问题澄清前不应直接暴露 Java 端口we shouldnt expose java ports directly否则将暴露在大量 Java 相关的安全风险之下——这解释了为什么部署栈中需要 Nginx 作为唯一对外入口而 Athens 的 3010 端口只在 Compose 内部网络中被代理访问。4.4 存储频率与数据安全的关系ADR 用三个例子说明了输出频率决定数据安全程度存储方式写入频率数据安全特征文件系统快照低频崩溃时可能丢失自上次快照以来的数据Postgres高频每次写入即持久化数据更安全Fluree高频事件级写入配合日志可恢复4.5 资源存储与身份数据ADR 还指出资源上传文件应与数据库存放在同一位置只要该存储支持一致性备份即可并追问若用 Fluree 存储资源该如何处理身份、权限等数据同样需要持久化。每个存储机制都有上限而这些上限会反过来限制允许上传的内容大小——团队当时尚缺这方面的数据计划按应用用例与 UX 设定限制。Compose 中 Fluree 注释提到的 2MB 事件上限可调至 10MB正是这类存储机制上限的现实例子。五、Nginx 反向代理WebSocket 长连接的正确打开方式nxginx.conf 是 ADR 中随镜像附带 Nginx 即可免去主机名配置决策的具体实现其核心价值在于正确代理 WebSocket 长连接events {} http { map $http_upgrade $connection_upgrade { default upgrade; close; } upstream websocket { server athens:3010; # Change the port based on config.edn } server { listen 80; location / { proxy_pass http://websocket; proxy_http_version 1.1; proxy_set_header Upgrade $http_upgrade; proxy_set_header Connection $connection_upgrade; proxy_set_header Host $host; proxy_connect_timeout 7d; proxy_send_timeout 7d; proxy_read_timeout 7d; } } }map $http_upgrade $connection_upgrade根据请求头动态决定Connection头——升级为 WebSocket 时置为upgrade普通 HTTP 请求置为close这是 Nginx 代理 WebSocket 的标准手法upstream指向athens:3010利用 Compose 内部 DNS 解析服务名3010与 config.default.edn 的默认端口一致三个7d超时proxy_connect_timeout/proxy_send_timeout/proxy_read_timeout均设为 7 天保证实时协作场景下 WebSocket 长连接不被 Nginx 空闲超时掐断proxy_set_header Host $host保留原始 Host 头配合 80 端口对外暴露用户无需配置主机名即可访问。Nginx 镜像由 nginx.dockerfile 构建基于官方nginx镜像将 nginx.conf 复制到/etc/nginx/nginx.conf。这条代理链路与后端实现完全咬合Athens 的实时协作走 WebSocket端点/ws定义在 components/web.clj接收消息后按事件类型分发presence 事件、:op/atomic原子操作等校验通过的事件再广播给所有客户端clients/broadcast!见 components/web.clj。若没有 Nginx 的 WebSocket 升级代理浏览器与服务器之间的长连接将无法建立因此 nginx 服务是整个部署栈中不可或缺的一环。六、决策的后果与后续演化路径ADR-0009 在后果Consequences一节明确承认了该决策的边界输入是 Docker Compose输出是 Volume——这是当前定义的部署契约数据韧性上限 用户对卷的管理能力快照、备份、异地冗余都取决于用户如果 DataHike 的磁盘损坏问题被进一步证实可能需要采用与卷作为输出不同的方案。从仓库现状看该决策已基本落地docker-compose.yml、nginx.conf、nginx.dockerfile、athens.dockerfile、script/docker-run-lan-party.sh五个工件构成了完整的可部署栈且 Compose 中的卷映射logs / datascript / fluree与 config.default.edn 中的默认路径严格对齐。同时仓库实际使用的持久化存储已从 DataHike 迁移到DataScript Fluree 事件日志的组合见 components/datascript.clj 的事件回放逻辑这本身就是 ADR 中发现 DataHike 磁盘损坏问题后可能需要采取不同方案的演进结果。部署时值得关注的两处 TODOFluree 新版镜像健康检查失效、Docker on M1 内存标志挂起问题也在 docker-compose.yml 的注释中有明确记载可作为后续维护的切入点。结语ADR-0009 的价值在于它把一个看似琐碎的怎么部署问题拆解成了安装、更新、数据韧性三个可验证的工程维度并用Docker Compose 作为输入、Volume 作为输出这一简洁契约完成了收敛。结合仓库源码可以看到Compose 里的每一个卷都对应着后端组件的一条真实持久化路径Nginx 的每一个超时参数都服务于 WebSocket 长连接的存活而component生命周期与事件日志回放则为安全更新与崩溃恢复提供了实现基础。对于任何需要自托管 Athens RTC 服务器、或希望理解事件溯源 快照持久化部署范式的读者这份 ADR 连同其部署工件都是一份值得反复对照研读的架构蓝本。参考文件索引决策记录doc/adr/0009-rtc-deployment.md部署编排docker-compose.yml、nginx.conf、nginx.dockerfile、athens.dockerfile启动脚本script/docker-run-lan-party.sh默认配置src/clj/config.default.edn配置加载与合并src/clj/athens/self_hosted/components/config.clj后端入口与组件装配src/clj/athens/self_hosted/core.cljWeb 服务与 WebSocket 处理src/clj/athens/self_hosted/components/web.cljDataScript 持久化与事件回放src/clj/athens/self_hosted/components/datascript.clj迁移测试test/athens/self_hosted/event_log_migrations_test.clj赞分享前端桌面应用数据库后端【免费下载链接】athensAthens is no longer maintainted. Athens was an open-source, collaborative knowledge graph, backed by YC W21项目地址https://gitcode.com/gh_mirrors/at/athens点击查看免费下载相关推荐NGINX 反向代理 WSGI Flask 分层部署实战基于 awesome-compose 的 Docker Compose 架构指南NGINX 反向代理 WSGI Flask 分层部署实战基于 awesome compose 的 Docker Compose 架构指南 导读本文以示例工程终极指南saliency框架CoreSaliency核心类完全解读终极指南saliency框架CoreSaliency核心类完全解读 在深度学习模型的可解释性领域saliency框架的CoreSaliency核心类扮演着至Nginx Web服务器与反向代理解决方案Docker-SWAGNginx Web服务器与反向代理解决方案Docker SWAG 项目基础介绍 Docker SWAG 是一个开源项目基于 Docker 容器技术构建主要上一篇Mac NTFS读写终极解决方案免费开源神器Nigate让文件传输零障碍下一篇强力卸载方案使用EdgeRemover彻底移除Windows系统中的Microsoft Edge浏览器创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表