Skip to content
This repository has been archived by the owner on Jun 20, 2023. It is now read-only.

mingwiki/anki-sync-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

anki-sync-server

1、安装docker,创建数据存储目录

$   apt/yum install docker docker-compose
$   mkdir /data/anki  # 用于本地存储anki数据,防止docker挂掉或者版本更新的时候数据丢失。

若修改路径,需同步更改docker-compose.yml文件

2、获取、使用anki-sync-server

1、直接从Docker Hub拉取

version: "3.5"
services:
  anki:
    restart: unless-stopped
    container_name: anki
    image: mingwiki/anki-sync-server:v1.2
    ports:
      - "27701:27701"
    volumes:
      - /data/anki:/data

2、从源码构建

源码二选一

$   git clone https://github.com/mingwiki/anki-sync-server.git  # Github 国外
$   git clone https://gitee.com/mingwiki/anki-sync-server.git  # gitee 国内

启动、停止server

$   cd anki-sync-server
$   docker-compose up -d  # 启动server,第一次启动会自动构建docker image
$   docker-compose down  # 停止server

更新至最新版本

$   git pull

3、进入docker管理anki用户

$   docker container exec -it anki bash # 进入容器
$   ./ankisyncctl.py help   # 获取命令
$   ./ankisyncctl.py adduser <username> # 添加用户
$   ./ankisyncctl.py deluser <username> # 删除用户
$   ./ankisyncctl.py lsuser             # 列出用户
$   ./ankisyncctl.py passwd <username>  # 更改用户密码

退出时输入exit即可。

4、桌面版Anki(2.1.43及以上)需要安装同步插件

点击工具--插件--查看本地插件文件,自动弹出插件目录

在该目录中新建文件夹,如syncd,进入后,新建文本文件__init__.py,内容如下

import os

addr = "https://example.com/" # 服务器地址,务必修改此处。
os.environ["SYNC_ENDPOINT"] = addr + "sync/"
os.environ["SYNC_ENDPOINT_MEDIA"] = addr + "msync/"

默认是http 27701端口,所以本地服务器地址格式为 http://127.0.0.1:27701/ ,需要做https的朋友继续下一步。

重启anki后,点击同步即可使用。

5、安卓Anki需要https/SSL证书

使用云服务器的朋友可以直接获得域名服务商提供的的免费SSL证书,本地自建服务器的需要生成本地证书。

$   apt/yum/brew install certbot
$   certbot certonly --standalone -d example.com   #生成证书包含三个文件xx.cer, xx.pem, xx.key。

生成本地SSL证书的软件很多,mkcert和openssl均可,网上教程很多。

本地建anki-server的朋友需要把生成证书的xx.cer文件,安装至安卓手机。使用云服务器的朋友不需要此步骤。

设置--安全--证书管理--安装证书,各种手机设置大同小异肯定有此选项。

有了证书以后需要设置nginx做反向代理,推荐配置如下

server {
    # Allow access via HTTPS
    listen 443 ssl;
    listen [::]:443 ssl;

    # Set server names for access
    server_name example.com; # 务必编辑此处

    # Set TLS certificates to use for HTTPS access
    ssl_certificate certs/example.com.pem; # 务必编辑此处
    ssl_certificate_key certs/example.com.key; # 务必编辑此处

    location / {
        # Prevent nginx from rejecting larger media files
        client_max_body_size 0;

        proxy_pass http://内网ip:27701; # 务必编辑此处
    }

重启nginx后AnkiDroid便可使用,配置地址应该类似如下格式。

https://example.com/
https://example.com/msync

!!!注意最后的斜杠不可省略,一个有一个没有。

!!!iOS/iPad 不支持第三方同步,且需要收费。