mirror of
https://github.com/ankitects/anki.git
synced 2026-07-28 10:18:47 -04:00
e9ac48cac2
<!-- Title (for the Pull Request title field at the top): Use a short prefix so the change type is obvious. You do not need to repeat it in the body below. Examples: - fix: — bugfix - feat: — feature - refactor: — internal change without user-facing feature - docs: — documentation only - chore: — tooling, CI, deps, build housekeeping - test: — tests only --> ## Linked issue (required) closes #5018 <!-- Fixes #123 / Closes #123 / Refs #123 --> ## Summary / motivation (required) This prevents large diffs with prettier being used with the mintlify editor A caveat of this is that the docs generated by cog now have to be prettier compatible. Also for some reason prettier has problems with the {/* */} multi-line comment format so we have to use <!-- --> instead. Sadly I don't have a good way to check that the Prettier config does not differ between this PR and the editor. --------- Co-authored-by: Abdo <abdo@abdnh.net>
121 lines
3.7 KiB
Plaintext
121 lines
3.7 KiB
Plaintext
---
|
|
title: "Building and running Anki in Docker"
|
|
---
|
|
|
|
This is an example Dockerfile contributed by an Anki user, which shows how Anki
|
|
can be both built and run from within a container. It works by streaming the GUI
|
|
over an X11 socket.
|
|
|
|
Building and running Anki within a container has the advantage of fully isolating
|
|
the build products and runtime dependencies from the rest of your system, but it is
|
|
a somewhat niche approach, with some downsides such as an inability to display natively
|
|
on Wayland, and a lack of integration with desktop icons/filetypes. But even if you
|
|
do not use this Dockerfile as-is, you may find it useful as a reference.
|
|
|
|
Anki's Linux CI runs on GitHub Actions. You can use, as references, the [`setup-anki`](https://github.com/ankitects/anki/blob/main/.github/actions/setup-anki/action.yml)
|
|
to see the lists of packages CI installs, and [`ci.yml`](https://github.com/ankitects/anki/blob/main/.github/workflows/ci.yml) to see the build steps that follow.
|
|
|
|
# Build the Docker image
|
|
|
|
For best results, enable BuildKit (`export DOCKER_BUILDKIT=1`).
|
|
|
|
When in this current directory, one can build the Docker image like this:
|
|
|
|
```bash
|
|
docker build --tag anki --file Dockerfile ../../
|
|
```
|
|
|
|
When this is done, run `docker image ls` to see that the image has been created.
|
|
|
|
If one wants to build from the project's root directory, use this command:
|
|
|
|
```bash
|
|
docker build --tag anki --file docs/docker/Dockerfile .
|
|
```
|
|
|
|
# Run the Docker image
|
|
|
|
Anki starts a graphical user interface, and this requires some extra setup on the user's
|
|
end. These instructions were tested on Linux (Debian 11) and will have to be adapted for
|
|
other operating systems.
|
|
|
|
To allow the Docker container to pull up a graphical user interface, we need to run the
|
|
following:
|
|
|
|
```bash
|
|
xhost +local:root
|
|
```
|
|
|
|
Once done using Anki, undo this with
|
|
|
|
```bash
|
|
xhost -local:root
|
|
```
|
|
|
|
Then, we will construct our `docker run` command:
|
|
|
|
```bash
|
|
docker run --rm -it \
|
|
--name anki \
|
|
--volume $HOME/.local/share:$HOME/.local/share:rw \
|
|
--volume /etc/passwd:/etc/passwd:ro \
|
|
--user $(id -u):$(id -g) \
|
|
--volume /tmp/.X11-unix:/tmp/.X11-unix:rw \
|
|
--env DISPLAY=$DISPLAY \
|
|
anki
|
|
```
|
|
|
|
Here is a breakdown of some of the arguments:
|
|
|
|
- Mount the current user's `~/.local/share` directory onto the container. Anki saves things
|
|
into this directory, and if we don't mount it, we will lose any changes once the
|
|
container exits. We mount this as read-write (`rw`) because we want to make changes here.
|
|
|
|
```bash
|
|
--volume $HOME/.local/share:$HOME/.local/share:rw
|
|
```
|
|
|
|
- Mount `/etc/passwd` so we can enter the container as ourselves. We mount this as
|
|
read-only because we definitely do not want to modify this.
|
|
|
|
```bash
|
|
--volume /etc/passwd:/etc/passwd:ro
|
|
```
|
|
|
|
- Enter the container with our user ID and group ID, so we stay as ourselves.
|
|
|
|
```bash
|
|
--user $(id -u):$(id -g)
|
|
```
|
|
|
|
- Mount the X11 directory that allows us to open displays.
|
|
|
|
```bash
|
|
--volume /tmp/.X11-unix:/tmp/.X11-unix:rw
|
|
```
|
|
|
|
- Pass the `DISPLAY` variable to the container, so it knows where to display graphics.
|
|
|
|
```bash
|
|
--env DISPLAY=$DISPLAY
|
|
```
|
|
|
|
# Running Dockerized Anki easily from the command line
|
|
|
|
One can create a shell function that executes the `docker run` command. Then one can
|
|
simply run `anki` on the command line, and Anki will open in Docker. Make sure to change
|
|
the image name to whatever you used when building Anki.
|
|
|
|
```bash
|
|
anki() {
|
|
docker run --rm -it \
|
|
--name anki \
|
|
--volume $HOME/.local/share:$HOME/.local/share:rw \
|
|
--volume /etc/passwd:/etc/passwd:ro \
|
|
--user $(id -u):$(id -g) \
|
|
--volume /tmp/.X11-unix:/tmp/.X11-unix:rw \
|
|
--env DISPLAY=$DISPLAY \
|
|
anki "$@"
|
|
}
|
|
```
|