🚀 Anki Sync Server - Docker

Anki Sync Server is a lightweight, efficient, self-hosted alternative to AnkiWeb for synchronizing your Anki decks across devices.

This Dockerized version is built on the original Anki Sync Server, offering an easy-to-deploy, privacy-friendly solution.

---

🌟 Features

• 🪶 Lightweight: Minimal image size (< 50MB) based on Distroless.
• ⚙️ Easy Deployment: Set up quickly with Docker Compose.
• 🛡️ Privacy-First: Your data stays with you.

---

📖 Usage

Run the server locally or on your homelab. Expose it to the internet securely using:

• An NGINX reverse proxy, or
• A reverse SSH tunnel.

---

🛠️ Requirements

Ensure the following are installed:

• Docker
• Docker Compose
• Git

---

⚡ Installation

1. Clone the repository:

   git clone https://github.com/EvanDufraisse/anki-sync-server.git
   cd anki-sync-server

2. Configure environment variables:

   cp .env_example .env

   Edit .env:

   HOST_PORT=27701              # Port on the host
   USERNAME1=admin              # First user
   PASSWORD1=admin              # User password
   ANKI_FILES_PATH=/path/to/anki/storage # Path to Anki storage

Adding multiple-users should be straitghforward see the official documentation

3. Build and run the server:

   docker-compose down && docker-compose up -d

4. Verify the container is healthy:

   docker container ls | grep anki-sync-server

   Debug if necessary:

   docker logs anki-sync-server

---

📝 TODO

• Add support for password hashing.

---

📜 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

🙌 Acknowledgements

• Anki - The intelligent flashcard program that makes remembering easy.