mirror of
https://github.com/ankitects/anki.git
synced 2025-09-18 14:02:21 -04:00
eaec53bfc4
Hardcode them to:
SYNC_PORT=8080
SYNC_BASE=/anki_data
If these env variables are passed into the container with different values,
they are ignored.
The reasons is if the user modifies SYNC_BASE they risk data loss since
anki-sync-server will no longer write data into the volume. If they change
SYNC_PORT they need to also change it when mapping this internal port to the
external port of the container, which could be confusing plus it has no benefit
to allow this since it's always possible to change the external port even if
the internal port is fixed to 8080 (e.g. `-p 1234:8080`).
In both cases there is no benefit to making these values configurable and there
are risks associated.
Unfortunately there is no easy way of implementing this for the
Dockerfile.distroless so it's up to the user not to modify these values.
95 lines
5.2 KiB
Markdown
95 lines
5.2 KiB
Markdown
# Building and running Anki sync server in Docker
|
|
|
|
This is an example Dockerfile contributed by an Anki user, which shows how you can run a self-hosted sync server,
|
|
similar to what AnkiWeb.net offers.
|
|
|
|
Building and running the sync server within a container has the advantage of fully isolating
|
|
the build products and runtime dependencies from the rest of your system.
|
|
|
|
## Requirements
|
|
|
|
- [x] [Docker](https://docs.docker.com/get-started/)
|
|
|
|
| **Aspect** | **Dockerfile** | **Dockerfile.distroless** |
|
|
| ---------------------- | ---------------------------------------------------------- | --------------------------------------------------------- |
|
|
| **Shell & Tools** | ✅ Includes shell and tools | ❌ Minimal, no shell or tools |
|
|
| **Debugging** | ✅ Easier debugging with shell and tools | ❌ Harder to debug due to minimal environment |
|
|
| **Health Checks** | ✅ Supports complex health checks | ❌ Health checks need to be simple or directly executable |
|
|
| **Image Size** | ❌ Larger image size | ✅ Smaller image size |
|
|
| **Customization** | ✅ Easier to customize with additional packages | ❌ Limited customization options |
|
|
| **Attack Surface** | ❌ Larger attack surface due to more installed packages | ✅ Reduced attack surface |
|
|
| **Libraries** | ✅ More libraries available | ❌ Limited libraries |
|
|
| **Start-up Time** | ❌ Slower start-up time due to larger image size | ✅ Faster start-up time |
|
|
| **Tool Compatibility** | ✅ Compatible with more tools and libraries | ❌ Compatibility limitations with certain tools |
|
|
| **Maintenance** | ❌ Higher maintenance due to larger image and dependencies | ✅ Lower maintenance with minimal base image |
|
|
| **Custom uid/gid** | ✅ It's possible to pass in PUID and PGID | ❌ PUID and PGID are not supported |
|
|
|
|
# Building image
|
|
|
|
To proceed with building, you must specify the Anki version you want, by replacing `<version>` with something like `24.11` and `<Dockerfile>` with the chosen Dockerfile (e.g., `Dockerfile` or `Dockerfile.distroless`)
|
|
|
|
```bash
|
|
# Execute this command from this directory
|
|
docker build -f <Dockerfile> --no-cache --build-arg ANKI_VERSION=<version> -t anki-sync-server .
|
|
```
|
|
|
|
# Run container
|
|
|
|
Once done with build, you can proceed with running this image with the following command:
|
|
|
|
```bash
|
|
# this will create anki server
|
|
docker run -d \
|
|
-e "SYNC_USER1=admin:admin" \
|
|
-p 8080:8080 \
|
|
--mount type=volume,src=anki-sync-server-data,dst=/anki_data \
|
|
--name anki-sync-server \
|
|
anki-sync-server
|
|
```
|
|
|
|
If the image you are using was built with `Dockerfile` you can specify the
|
|
`PUID` and `PGID` env variables for the user and group id of the process that
|
|
will run the anki-sync-server process. This is valuable when you want the files
|
|
written and read from the `/anki_data` volume to belong to a particular
|
|
user/group e.g. to access it from the host or another container. Note the the
|
|
ids chosen for `PUID` and `PGID` must not already be in use inside the
|
|
container (1000 and above is fine). For example add `-e "PUID=1050"` and `-e
|
|
"PGID=1050"` to the above command.
|
|
|
|
If you want to have multiple Anki users that can sync their devices, you can
|
|
specify multiple `SYNC_USER` as follows:
|
|
|
|
```bash
|
|
# this will create anki server with multiple users
|
|
docker run -d \
|
|
-e "SYNC_USER1=admin:admin" \
|
|
-e "SYNC_USER2=admin2:admin2" \
|
|
-p 8080:8080 \
|
|
--mount type=volume,src=anki-sync-server-data,dst=/anki_data \
|
|
--name anki-sync-server \
|
|
anki-sync-server
|
|
```
|
|
|
|
Moreover, you can pass additional env vars mentioned
|
|
[here](https://docs.ankiweb.net/sync-server.html). Note that `SYNC_BASE` and
|
|
`SYNC_PORT` will be ignored. In the first case for safety reasons, to avoid
|
|
accidentally placing data outside the volume and the second for simplicity
|
|
since the internal port of the container does not matter given that you can
|
|
change the external one.
|
|
|
|
# Upgrading
|
|
|
|
If your image was built after January 2025 then you can just build a new image
|
|
and start a new container with the same configuration as the previous
|
|
container. Everything should work as expected.
|
|
|
|
If the image you were running was built **before January 2025** then it did not
|
|
contain a volume, meaning all syncserver data was stored inside the container.
|
|
If you discard the container, for example because you want to build a new
|
|
container using an updated image, then your syncserver data will be lost.
|
|
|
|
The easiest way of working around this is by ensuring at least one of your
|
|
devices is fully in sync with your syncserver before upgrading the Docker
|
|
container. Then after upgrading the container when you try to sync your device
|
|
it will tell you that the server has no data. You will then be given the option
|
|
of uploading all local data from the device to syncserver.
|