anki-sync-server/README.md

50 lines
1.5 KiB
Markdown
Raw Normal View History

2013-10-20 14:07:36 +08:00
ankisyncd
=========
2013-07-18 09:22:21 +08:00
2017-10-29 11:21:22 +08:00
[Anki][] is a powerful open source flashcard application, which helps you
quickly and easily memorize facts over the long term utilizing a spaced
repetition algorithm. Anki's main form is a desktop application (for Windows,
Linux and macOS) which can sync to a web version (AnkiWeb) and mobile
versions for Android and iOS.
This is a personal Anki server, which you can sync against instead of
AnkiWeb. It was originally developed to support the flashcard functionality
on Bibliobird, a web application for language learning.
This version has been modified from [dsnopek's Anki Sync Server][] to remove
the REST API, which makes it possible to drop some dependencies.
2013-07-18 09:22:21 +08:00
Installing
----------
1. Install the dependencies:
2017-10-29 02:43:09 +08:00
$ pip install webob
2. Modify ankisyncd.conf according to your needs
3. Create user:
2013-08-02 02:06:51 +08:00
2013-10-30 05:48:02 +08:00
$ ./ankisyncctl.py adduser <username>
2013-08-02 02:06:51 +08:00
4. Run ankisyncd:
2013-10-30 05:48:02 +08:00
2017-11-07 03:00:24 +08:00
$ python ./ankisyncd/sync_app.py ankisyncd.conf
2013-08-02 02:06:51 +08:00
2013-10-21 07:57:58 +08:00
Setting up Anki
---------------
2013-10-21 08:03:47 +08:00
To make Anki use ankisyncd as its sync server, create a file (name it something
like ankisyncd.py) containing the code below and put it in ~/Anki/addons.
2013-10-21 07:57:58 +08:00
import anki.sync
2013-10-21 08:03:47 +08:00
2014-07-22 21:29:02 +08:00
anki.sync.SYNC_BASE = 'http://127.0.0.1:27701/'
2015-11-29 12:53:58 +08:00
anki.sync.SYNC_MEDIA_BASE = 'http://127.0.0.1:27701/msync/'
2013-10-21 07:57:58 +08:00
2013-10-21 08:03:47 +08:00
Replace 127.0.0.1 with the IP address or the domain name of your server if
ankisyncd is not running on the same machine as Anki.
2017-10-29 11:21:22 +08:00
[Anki]: https://apps.ankiweb.net/
[dsnopek's Anki Sync Server]: https://github.com/dsnopek/anki-sync-server