anki/docs
Damien Elmes cf45cbf429
Rework syncing code, and replace local sync server (#2329)
This PR replaces the existing Python-driven sync server with a new one in Rust.
The new server supports both collection and media syncing, and is compatible
with both the new protocol mentioned below, and older clients. A setting has
been added to the preferences screen to point Anki to a local server, and a
similar setting is likely to come to AnkiMobile soon.

Documentation is available here: <https://docs.ankiweb.net/sync-server.html>

In addition to the new server and refactoring, this PR also makes changes to the
sync protocol. The existing sync protocol places payloads and metadata inside a
multipart POST body, which causes a few headaches:

- Legacy clients build the request in a non-deterministic order, meaning the
entire request needs to be scanned to extract the metadata.
- Reqwest's multipart API directly writes the multipart body, without exposing
the resulting stream to us, making it harder to track the progress of the
transfer. We've been relying on a patched version of reqwest for timeouts,
which is a pain to keep up to date.

To address these issues, the metadata is now sent in a HTTP header, with the
data payload sent directly in the body. Instead of the slower gzip, we now
use zstd. The old timeout handling code has been replaced with a new implementation
that wraps the request and response body streams to track progress, allowing us
to drop the git dependencies for reqwest, hyper-timeout and tokio-io-timeout.

The main other change to the protocol is that one-way syncs no longer need to
downgrade the collection to schema 11 prior to sending.
2023-01-18 12:43:46 +10:00
..
docker Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00
architecture.md Updated permalink to architecture visualization (#2001) 2022-08-05 14:47:38 +10:00
build.md Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00
contributing.md Facilitate hook updating/replacement (#2213) 2022-12-07 15:39:57 +10:00
development.md Fix TTS handling on Windows 2022-11-29 13:04:51 +10:00
editing.md Minor Rust cleanups (#2272) 2022-12-16 21:40:27 +10:00
linux.md Mention how to fix build crash in the readme. (#2286) 2022-12-30 13:10:37 +10:00
mac.md Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00
ninja.md Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00
protobuf.md Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00
windows.md Move away from Bazel (#2202) 2022-11-27 15:24:20 +10:00