oleduc/docker-obsidian-livesync-couchdb

Obsidian LiveSync 的 CouchDB 配置

本仓库提供一个 Docker 容器，用于专门为 https://github.com/vrtmrz/obsidian-livesync 配置 CouchDB。它通过解析 Obsidian LiveSync 维护者提供的 bash 脚本（couchdb-init.sh）并根据插件所需的设置更新 CouchDB 的配置文件（local.ini），从而自动化设置过程。

容器通过 GitHub Actions 自动构建和发布。

https://hub.docker.com/r/oleduc/docker-obsidian-livesync-couchdb

特性

• 自动化 CouchDB 配置：从插件维护者创建的 bash 脚本中提取 Obsidian LiveSync 所需的必要设置。
• 构建时配置：通过配置文件在构建时配置 CouchDB，而非使用 CouchDB API，简化了流程。
• 多架构支持：原生支持 AMD64（x86_64）和 ARM64 架构，包括 Apple Silicon Mac。
• 自动发布：Docker 镜像通过 GitHub Actions 自动构建并推送到容器仓库。

测试配置

要验证更新后的配置：

打开您的 CouchDB 仪表板（[***]
检查设置是否已应用于 /_node/_local/_config。

Docker 概述

本项目使用复杂的 CI/CD 流水线确保可靠的 Docker 镜像构建和发布：

构建过程

• 自动化测试：每次推送和拉取请求都会触发使用 Deno 进行的兼容性测试，以验证上游 CouchDB 初始化脚本
• 多架构构建：为 linux/amd64 和 linux/arm64 平台构建 Docker 镜像
• 高效缓存：使用 GitHub Actions 缓存加速后续构建
• 构建验证：每次提交都会构建和测试镜像，但仅在发布时才会发布

CI/CD 工作流

工作流包含两个主要作业：

1. 构建作业（在推送/PR 时运行）：

   • 与上游 Obsidian LiveSync 脚本进行兼容性测试
   • 构建多平台 Docker 镜像
   • 使用 GitHub Actions 缓存提高效率
   • 验证构建但不发布

2. 发布作业（仅在 GitHub 发布时运行）：

   • 使用构建作业的缓存层进行快速重建
   • 将镜像发布到 Docker Hub
   • 使用 Cosign 对镜像进行签名以确保安全性
   • 仅在 GitHub 上创建新版本时运行

发布策略

• 开发：所有推送都会触发构建和测试，但不会发布
• 生产：仅 GitHub 发布会触发镜像发布到 Docker Hub
• 版本控制：镜像使用 GitHub 发布的语义化版本进行标记
• 安全性：所有发布的镜像都经过签名并可验证

可用标签

创建 GitHub 发布（例如 v1.2.3）时，会自动创建以下标签：

• latest：最新稳定版本
• 1.2.3：发布标签的精确版本
• 1.2：主版本.次版本
• 1：仅主版本

Docker Hub 集成

本仓库与 Docker Hub 集成，地址为 https://hub.docker.com/r/oleduc/docker-obsidian-livesync-couchdb%EF%BC%9A

• 自动发布：GitHub Actions 在发布时自动将镜像推送到 Docker Hub
• 语义化版本控制：每个发布创建多个标签，便于灵活固定版本
• 多架构清单：Docker Hub 为您的平台提供相应的镜像
• 描述同步：仓库描述和文档同步到 Docker Hub
• 签名镜像：所有发布的镜像均使用 Cosign 进行加密签名，以确保安全验证

架构特定的标签由 Docker 的清单列表自动处理。

拉取 Docker 镜像

要使用预构建镜像，请从容器仓库拉取：

bash
docker pull docker.io/oleduc/docker-obsidian-livesync-couchdb:latest

多架构支持：此镜像支持 AMD64（x86_64）和 ARM64 架构，包括 Apple Silicon Mac、基于 ARM 的服务器和其他 ARM64 设备。Docker 会自动为您的平台拉取正确的架构。

运行容器

运行已配置用于 Obsidian LiveSync 的 CouchDB 容器：

bash
docker run -d \
  -e SERVER_DOMAIN=example.com \
  -e COUCHDB_USER=username \
  -e COUCHDB_PASSWORD=password \
  -e COUCHDB_DATABASE=obsidian \
  -p 5984:5984 \
  docker.io/oleduc/docker-obsidian-livesync-couchdb:master

或通过 docker-compose：

yaml
version: "3.8"

services:
  couchdb-obsidian-livesync:
    image: docker.io/oleduc/docker-obsidian-livesync-couchdb:master
    container_name: couchdb-obsidian-livesync
    restart: always
    environment:
      SERVER_URL: ${SERVER_URL}
      COUCHDB_USER: ${COUCHDB_USER}
      COUCHDB_PASSWORD: ${COUCHDB_PASSWORD}
      COUCHDB_DATABASE: ${COUCHDB_DATABASE}
    ports:
      - "${COUCHDB_PORT:-5984}:5984"
    volumes:
      - ${COUCHDB_DATA}:/opt/couchdb/data

许可证

本仓库采用 MIT 许可证。欢迎贡献！

致谢

• https://github.com/vrtmrz/obsidian-livesync
• CouchDB 提供出色的分布式数据库解决方案。
• Obsidian 提供出色的笔记应用。