Skip to content

Commit 42e1546

Browse files
improves codebase
1 parent 4c1b1c7 commit 42e1546

File tree

2 files changed

+27
-11
lines changed

2 files changed

+27
-11
lines changed

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,32 @@ Also uses `curl` to call AnkiConnect. It forces a sync and optionally reschedule
3737

3838
---
3939

40+
## How to run
41+
42+
If you want you can run this using the image `mlcivilengineer/anki-desktop-docker` which is automatically built using Github Actions in this repo. Use the following command:
43+
```bash
44+
docker run -d \
45+
--name anki-desktop \
46+
-e PUID=1000 \
47+
-e PGID=1000 \
48+
-v "$(pwd)/anki_data:/config" \
49+
-p 3000:3000 \
50+
-p 8765:8765 \
51+
mlcivilengineer/anki-desktop-docker:latest
52+
```
53+
54+
Then open your browser and head to:
55+
56+
```
57+
http://localhost:3000
58+
```
59+
60+
Press Enter after Anki is installed for the first time. Now you can use it as normal. In order to sync with the other clients, put your sync information in the Sync tab.
61+
62+
4063
## Docker Compose Setup
4164

42-
Use the `docker-compose.yml` in the root of the repo:
65+
If you prefer docker compose instead, use the `docker-compose.yml` in the root of the repo:
4366
```yaml
4467
services:
4568
anki-desktop:
@@ -50,7 +73,7 @@ services:
5073
- PUID=1000
5174
- PGID=1000
5275
volumes:
53-
- ./config:/config
76+
- ./anki_data:/config
5477
ports:
5578
- 3000:3000 # Web UI
5679
- 8765:8765 # AnkiConnect
@@ -62,17 +85,9 @@ To get started:
6285
```bash
6386
git clone <this-repo>
6487
cd anki-desktop-docker
65-
docker compose up --build -d
66-
```
67-
68-
Then open your browser and head to:
69-
70-
```
71-
http://localhost:3000
88+
docker compose up -d
7289
```
7390

74-
Press Enter after Anki is installed for the first time. Now you can use it as normal. In order to sync with the other clients, put your sync information in the Sync tab.
75-
7691
---
7792

7893
## AnkiConnect Configuration

docker-compose.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
services:
22
anki-desktop:
3+
image: mlcivilengineer/anki-desktop-docker:latest
34
build:
45
context: ./
56
dockerfile: Dockerfile

0 commit comments

Comments
 (0)