anki-sync-server/README.md

ankisyncd
=========

A personal Anki sync server (so you can sync against your own server rather than
AnkiWeb). This version has been modified from dsnopek's Anki Sync Server to
remove the REST API, which makes it possible to drop some dependencies.

Installing
----------

1. Install the dependencies:

        $ pip install webob

2. Patch the bundled libanki:

	$ ./patch_libanki.sh

3. Modify ankisyncd.conf according to your needs

4. Create user:

        $ ./ankisyncctl.py adduser <username>

5. Run ankisyncd:

        $ python ./ankisyncd/sync_app.py

Setting up Anki
---------------

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.

    import anki.sync

    anki.sync.SYNC_BASE = 'http://127.0.0.1:27701/'
    anki.sync.SYNC_MEDIA_BASE = 'http://127.0.0.1:27701/msync/'

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.
Update README.md 2013-10-20 14:07:36 +08:00			`ankisyncd`
			`=========`
Changed INSTALL.txt to README.txt. 2013-07-18 09:22:21 +08:00
Updated README 2013-10-20 13:36:27 +08:00			`A personal Anki sync server (so you can sync against your own server rather than`
Update README.md 2016-04-06 00:30:30 +08:00			`AnkiWeb). This version has been modified from dsnopek's Anki Sync Server to`
			`remove the REST API, which makes it possible to drop some dependencies.`
Changed INSTALL.txt to README.txt. 2013-07-18 09:22:21 +08:00
			`Installing`
			`----------`
Committed old Anki 1.2 sync server code. It's not very generic. :-/ 2013-04-03 21:31:44 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`1. Install the dependencies:`
Committed old Anki 1.2 sync server code. It's not very generic. :-/ 2013-04-03 21:31:44 +08:00
Remove support for legacy modules 2017-10-29 02:43:09 +08:00			`$ pip install webob`
Committed old Anki 1.2 sync server code. It's not very generic. :-/ 2013-04-03 21:31:44 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`2. Patch the bundled libanki:`
Committed old Anki 1.2 sync server code. It's not very generic. :-/ 2013-04-03 21:31:44 +08:00
Apply @ndl's patches The patches fix the issue where syncing across different profiles will always trigger a full sync if there's any change in either of the profiles. 2016-11-03 22:44:40 +08:00			`$ ./patch_libanki.sh`
Committed old Anki 1.2 sync server code. It's not very generic. :-/ 2013-04-03 21:31:44 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`3. Modify ankisyncd.conf according to your needs`
Squashed commit of the following: commit cb509e8f75e3dcdbc66327be4bfbf6661aa084b5 Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 22:06:28 2013 +0100 Cut down 'import' statements to only modules actually used. commit 0ea255115e095e31af5a991e9cce2b5b15cb496d Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 22:00:06 2013 +0100 * Add getCollectionManager() so that the whole process can share the same ThreadingCollectionManager object. * Got the RestApp actually working! commit 00997bab600b13d4b430ed2c2839b1d2232f55ed Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 21:04:58 2013 +0100 Got the sync_app working again (more or less) commit 459c69566bb92d2c0195a384e067d98c059bdea7 Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 19:47:40 2013 +0100 Started implementing test for the RESTful callbacks that PrepECN is going to need. commit 7ffbac793f9bf45ab9056c1de475422b8742e107 Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 17:19:06 2013 +0100 Started work on a WSGI app for RESTful access to Anki based on Bibliobird code here: https://raw.github.com/dsnopek/bbcom/master/AnkiServer/AnkiServer/deck.py commit 8820411388ce0c2b7b14769c614c22c675d2dbdd Author: David Snopek <dsnopek@gmail.com> Date: Fri Jul 12 15:03:56 2013 +0100 * Seperated the collection and threading code. * Implemented a new interface to interact with the collections, which will hopefully be more transparent and testable. 2013-07-13 05:08:16 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`4. Create user:`
Updated README.md 2013-08-02 02:06:51 +08:00
Update README.md 2013-10-30 05:48:02 +08:00			`$ ./ankisyncctl.py adduser <username>`
Updated README.md 2013-08-02 02:06:51 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`5. Run ankisyncd:`
Update README.md 2013-10-30 05:48:02 +08:00
Remove superfluous/outdated instructions 2017-10-29 02:40:32 +08:00			`$ python ./ankisyncd/sync_app.py`
Updated README.md 2013-08-02 02:06:51 +08:00
Update README.md 2013-10-21 07:57:58 +08:00			`Setting up Anki`
			`---------------`

Update README.md 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.`
Update README.md 2013-10-21 07:57:58 +08:00
			`import anki.sync`
Update README.md 2013-10-21 08:03:47 +08:00
Update README.md 2014-07-22 21:29:02 +08:00			`anki.sync.SYNC_BASE = 'http://127.0.0.1:27701/'`
Fix syncing with AnkiDroid 2015-11-29 12:53:58 +08:00			`anki.sync.SYNC_MEDIA_BASE = 'http://127.0.0.1:27701/msync/'`
Update README.md 2013-10-21 07:57:58 +08:00
Update README.md 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.`