A cross-platform Anki sync server.
This is a rust (still sqlite c library backed) take on anki sync server (for a mature python one see ankicommunity/anki-sync-server).
- Install anki-sync-server-rs, see underneath or INSTALL.md for more information.
- Configure it (see template configuration
ankisyncd.toml
,Optional) - Run the server
- Add user to the server
- Configure your client to sync with the custom server, see here
For https setup and support see certificate setup. See reverse proxy setup for setting up a reverse proxy in front of the sync server.
- Grab binary from github releases and unpack it, each platform has its corresponding tag (e.g.
windows_x86_64
for Windows 64bit,details see support platform ) , or even better build it from source (seeINSTALL.md
) - Tweak the configuration
ankisyncd.toml
to your liking (if you want to use it,optional) - Run server
./ankisyncd
(./ankisyncd.exe
or double click for windows,use--config ANKISYNCD_CONFIG_PATH
if needed) - Add user
./ankisyncd user --add username password
(./ankisyncd.exe
for windows use./ankisyncd user --help
for more on user management, add--config ANKISYNCD_CONFIG_PATH
to the command when using a config file) - Enjoy!
see containerized build/install
See CONTRIBUTING.md.
All contributions must be licensed under AGLP-v3.0 to comply with the license of the anki code used as the base of this project.
See LICENSE
It should work on any tier 1/2 platform of the rust ecosystem. But have only been tested on the following.
Win 10 64bits
machine | ENV |
---|---|
x86_64 | Windows wsl2,tested |
aarch64(arm64) | cross-compiled on wsl2(ubuntu),tested on ubuntu aarch64 and termux |
armv7(arm32) | cross-compiled on wsl2(ubuntu) |
tested anki versions | 2.1.15,2.1.28,2.1.35,2.1.50 |
---|---|
tested process | import a collection of decks and upload to server |
ankisyncd architecture or apis depend on ankicommunity/anki-sync-server and ankitects/anki. Sync APIs are based on anki/rslib 2.1.46