myflow/anki-sync-server

anki-sync-server 镜像文档

镜像概述

anki-sync-server 是一个个人Anki同步服务器镜像，提供与Anki官方同步服务AnkiWeb兼容的功能，允许用户将Anki记忆卡片数据同步到自建服务器，而非依赖第三方服务。该镜像旨在增强用户对数据的控制权和隐私保护，适合需要本地管理Anki同步数据的场景。

核心功能和特性

• Anki兼容同步：完全兼容Anki客户端（2.1.50+版本）的同步协议，支持卡片、笔记、 decks等数据的双向同步
• 数据本地存储：所有同步数据存储在用户自己的服务器中，避免数据上传至第三方
• 轻量级部署：基于Python构建，资源占用低，适合个人服务器或家庭NAS部署
• 用户管理：支持创建和管理多个用户账户，满足多用户使用需求
• 跨平台支持：兼容Windows、macOS、Linux等所有Anki客户端平台

使用场景和适用范围

• 隐私敏感用户：希望避免个人学习数据上传至第三方服务的用户
• 本地数据管理：需要将Anki数据存储在自有服务器或NAS中的个人或家庭用户
• 网络限制环境：在无法访问AnkiWeb的网络环境中使用Anki同步功能
• 多设备同步需求：需要在多台设备间同步Anki数据，但希望通过自建服务实现

使用方法和配置说明

基本部署（Docker Run）

bash
# 基本运行命令（首次启动会自动创建默认用户）
docker run -d \
  --name anki-sync-server \
  -p 27701:27701 \
  -v /path/to/anki/data:/app/data \
  docker.xuanyuan.run/myflow/anki-sync-server

参数说明：

• -p 27701:27701：映射容器端口到主机（默认端口27701）
• -v /path/to/anki/data:/app/data：挂载数据目录，持久化存储Anki同步数据

创建用户

容器启动后，可通过以下命令创建新用户：

bash
# 进入容器
docker exec -it anki-sync-server /bin/sh

# 创建用户（替换<username>和<password>为实际用户名和密码）
python3 -m ankisyncd.cli adduser <username> <password>

Docker Compose 配置

创建docker-compose.yml文件：

yaml
version: '3'
services:
  anki-sync-server:
    image: docker.xuanyuan.run/myflow/anki-sync-server
    container_name: anki-sync-server
    ports:
      - "27701:27701"
    volumes:
      - ./anki-data:/app/data
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

Anki客户端配置

1. 打开Anki客户端，进入「工具」>「附加组件」
2. 点击「获取插件」，输入插件代码：1534775904（Anki Sync Server插件）
3. 安装完成后，重启Anki
4. 进入「工具」>「Anki Sync Server」>「设置」
5. 输入服务器地址（格式：http://your-server-ip:27701/）
6. 保存设置后，使用创建的用户名和密码进行同步

环境变量配置

可通过环境变量自定义服务器配置：

示例（自定义端口）：

bash
docker run -d \
  --name anki-sync-server \
  -p 8080:8080 \
  -v /path/to/anki/data:/app/data \
  -e SYNC_PORT=8080 \
  myflow/anki-sync-server