You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 957442e
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.en.md
+13-3Lines changed: 13 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ An AI-powered notebook for the questions you got wrong. Snap a photo or type a q
30
30
31
31
-**🆓 Works with free accounts**: choose the "MiniMax Code OAuth" channel and sign in with a MiniMax Code account in the browser, with no API key to buy; the app checks in every day to collect credits (see [MiniMax Code OAuth](#minimax-code-oauth)). New Volcengine users also get a [free inference quota](#volcengine-free-trial).
32
32
-**📚 A complete review loop**: auto-graded similar questions, AI mastery estimates, daily review at Ebbinghaus intervals, and printable exams built from your mistakes with per-question results.
33
-
-**📦 Install anywhere**: Docker image (amd64 / arm64), npm, Windows, macOS, Linux, fnOS, Android phones and tablets (standalone or client), or add it to your home screen as a PWA.
33
+
-**📦 Install anywhere**: Docker image (amd64 / arm64), npm, Windows, macOS, Linux, fnOS, Synology/QNAP packages, Android phones and tablets (standalone or client), or add it to your home screen as a PWA.
34
34
35
35
> This repository is a fork of [wttwins/wrong-notebook](https://github.com/wttwins/wrong-notebook); most of the features above and below were added here. The built-in knowledge-point library follows the Chinese K-12 curriculum (primary, junior high and senior high school). The interface is available in Simplified Chinese and English.
36
36
@@ -193,7 +193,7 @@ Practice statistics show total practice, accuracy (correct / attempted) and acti
193
193
194
194
Ordered from easiest to most hands-on. Fresh installs have no default account: the first start generates a one-time setup link where you choose the admin email and password, then the setup wizard helps you set up an AI provider and create your first notebook. The desktop and standalone Android apps open the link automatically; for Docker run `docker logs wrong-notebook 2>&1 | grep initialize`; npm and source runs print it in the terminal. If the link host is `localhost`, replace it with the server address when opening it from another device (or set `NEXTAUTH_URL`). Until an admin exists, the sign-in page shows these instructions too.
Download the package for your platform from the [download page](https://wrong-notebook.margrop.net/en/download/) (detects your OS and architecture) or from [Releases](https://github.com/margrop/wrong-notebook/releases), install it and open it:
199
199
@@ -203,6 +203,8 @@ Download the package for your platform from the [download page](https://wrong-no
@@ -295,6 +297,10 @@ Unraid creates the host directories if they do not exist. After the first start,
295
297
296
298
DSM 7.2 or later uses **Container Manager** (older versions use the Docker package). The suggested data directory is `/volume1/docker/wrong-notebook/{data,config}`; create it first in File Station or over SSH, and replace the path if your storage volume differs.
297
299
300
+
**Package install (recommended)**: install Container Manager first, then choose `WrongNotebook-Synology-<version>.spk` under Package Center → **Manual Install**. The package pulls the matching image, generates `NEXTAUTH_SECRET`, maps host port `39300` to container `3000`, and stores data at `<package volume>/docker/wrong-notebook/{data,config}`; the Package Center **Open** link opens the app, and the first start shows the admin setup page. Upgrading the package recreates the container from the new image and keeps data; uninstalling keeps the data directory.
301
+
302
+
Manual container method:
303
+
298
304
1.**Pull the image**: Container Manager → **Image** → Add, search the registry for `margrop/wrong-notebook`, or add `ghcr.io/margrop/wrong-notebook:<exact-version>` by URL.
299
305
2.**Create the container**: **Container** → Add → Create from image. Name it `wrong-notebook`; map host port `3000` → container `3000`; mount `/volume1/docker/wrong-notebook/data` → `/app/data` and `.../config` → `/app/config` (read/write); set `NEXTAUTH_SECRET`, `NEXTAUTH_URL` and `PRESERVE_EXISTING_DATA=true`; enable auto restart.
300
306
3.**Initialize**: after starting, find the `initialize` link in the container details log (the token is also in `/volume1/docker/wrong-notebook/config/setup-token`), then set the admin email and password.
@@ -305,6 +311,10 @@ DSM 7.2 or later uses **Container Manager** (older versions use the Docker packa
305
311
306
312
Use **Container Station**. The suggested data directory is `/share/Container/wrong-notebook/{data,config}`; Container Station's default shared folder is `Container`, so replace the path if you store data elsewhere.
307
313
314
+
**Package install (recommended)**: install Container Station first, then choose `WrongNotebook-QNAP-<version>.qpkg` under App Center → **Manual Install**. The package pulls the matching image, generates `NEXTAUTH_SECRET`, maps host port `39300` to container `3000`, and stores data at `/share/Container/wrong-notebook/{data,config}`; the App Center open link opens the app, and the first start shows the admin setup page. Upgrading the package recreates the container from the new image and keeps data; uninstalling keeps the data directory.
315
+
316
+
Manual container method:
317
+
308
318
1.**Pull the image**: pull `ghcr.io/margrop/wrong-notebook:<exact-version>` on the image page; you can also run `docker pull` over SSH or use an **Application** (Compose).
309
319
2.**Create the container**: Container → Create, select the pulled image. Name it `wrong-notebook`; map host port `3000` → container `3000`; mount `/share/Container/wrong-notebook/data` → `/app/data` and `.../config` → `/app/config`; set `NEXTAUTH_SECRET`, `NEXTAUTH_URL` and `PRESERVE_EXISTING_DATA=true`; restart policy `unless-stopped`.
310
320
3.**Initialize**: after starting, find the `initialize` link in the container log (the token is in `/share/Container/wrong-notebook/config/setup-token`).
@@ -591,7 +601,7 @@ For usage, deployment and FAQ, see the [Wiki in English](https://github.com/marg
591
601
592
602
| Document | Content |
593
603
| :--- | :--- |
594
-
|[INSTALL_PACKAGES.md](doc/INSTALL_PACKAGES.md)| npm, desktop, fnOS and Android packages and builds |
604
+
|[INSTALL_PACKAGES.md](doc/INSTALL_PACKAGES.md)| npm, desktop, fnOS, Synology/QNAP packages and Android packages and builds |
595
605
|[HTTPS_SETUP.md](doc/HTTPS_SETUP.md)| HTTPS setup (needed for screen capture) |
596
606
|[TIME_ZONE.md](doc/TIME_ZONE.md)| Application time zone |
0 commit comments