aguslr/ankiweb

By aguslr

Updated 3 days ago

Set up AnkiWeb to sync Anki decks over the network

Image
0

574

aguslr/ankiweb repository overview

aguslr/docker-ankiweb

docker-pulls image-size

This Docker image sets up AnkiWeb inside a docker container.

AnkiWeb is a free companion to the computer version of Anki. AnkiWeb can be used to review online when you don't have access to your home computer, and can be used to keep your cards synchronized across multiple machines

Installation

To use docker-ankiweb, follow these steps:

  1. Clone and start the container:

    docker run -p 8080:8080 \
      -e [email protected]:pass1 \
      -v ./data:/data \
      docker.io/aguslr/ankiweb:latest
    
  2. On your Anki app, go to Preferences > Syncing and enter http://127.0.0.1:8080 as the self-hosted sync server.

  3. Log In with your credentials [email protected] and pass1.

Variables

The image is configured using environment variables passed at runtime:

VariableFunctionDefaultRequired
SYNC_HOSTIP address to listen on127.0.0.1N
SYNC_PORTPort to listen on8080N
SYNC_BASEDirectory to store data/dataN
PASSWORDS_HASHEDWhether to use hashed passwords0N
SYNC_USER1First user's username:passwordEMPTYY
SYNC_USER<N><N> user's username:passwordEMPTYN
MAX_SYNC_PAYLOAD_MEGSUpload limit in MB100N

Build locally

Instead of pulling the image from a remote repository, you can build it locally:

  1. Clone the repository:

    git clone https://github.com/aguslr/docker-ankiweb.git
    
  2. Change into the newly created directory and use docker-compose to build and launch the container:

    cd docker-ankiweb && docker-compose up --build -d
    

Tag summary

Content type

Image

Digest

sha256:abd759d8d

Size

50.7 MB

Last updated

3 days ago

Requires Docker Desktop 4.37.1 or later.