Commit Graph

87 Commits

Author SHA1 Message Date
Vikash Kothary
a9a2bb5646
docs: Add acknowledgements section
Resolves https://github.com/ankicommunity/anki-sync-server/issues/161
2023-03-26 11:02:32 +01:00
Vikash Kothary
4d2edcefc2 docs: Add badges for PyPI, DockerHub and GitHub 2022-10-14 19:28:47 +01:00
Izidor Matušov
5d0e1faaf9 Document how to set up SSL proxy 2022-10-13 21:31:42 +03:00
Cash Weaver
a99f723ed0 docs: Add -e src to installation instructions
Mentions `pip install -e src` in the installation instructions.
2022-08-26 09:24:35 -07:00
Vikash Kothary
5beabf9764 docs: Update the command to create a new user in the README 2022-07-02 15:00:09 +01:00
Vikash Kothary
bab67692d4 docs: Add known issues section in README 2022-07-02 14:47:34 +01:00
Cycatz
48005abc59 Fix addon-folder doc link 2022-06-29 12:15:38 +01:00
dobefore
a506785273 request change and readme modification 2022-03-08 22:18:11 +00:00
Vikash Kothary
251df33e4e docs: Fix indentation in nginx example snippet 2022-03-08 22:13:46 +00:00
Vikash Kothary
682e8a3c48 docs: Fix path to example nginx config file 2022-03-08 22:13:05 +00:00
TomRomeo
7ef846c52e fix: modified nginx config 2022-03-08 22:08:27 +00:00
Vikash Kothary
ef2086fbbe docs: Add sub-headers for the two types of configuration 2022-03-08 21:18:14 +00:00
Vikash Kothary
f0da921f53 docs: Add command to simplify the process of using config file 2022-03-08 21:05:43 +00:00
Vikash Kothary
127c35eec6 docs: Move info on environment variables under the appropriate heading 2022-03-08 21:03:05 +00:00
Marcel Ackermann
8ccf4453e1 include env config for docker 2022-03-08 20:51:26 +00:00
dobefore
0759773a69 easy_addon_install_fix_layout_error 2021-10-04 13:10:01 +08:00
dobefore
7fb13afc17 update 2021-07-25 11:57:31 +08:00
dobefore
acb814ab59 update_readme 2021-07-17 20:18:30 +08:00
dobefore
93b5e4981e update_readme 2021-07-17 19:55:55 +08:00
valuex
06b81d8d84
Update README.md
Change the Installing (Docker) hyperlink to the lastest url
2021-03-20 18:55:19 +08:00
Vikash Kothary
f73e3d5f8c Add documentation on how to run tests 2020-12-27 18:13:14 +00:00
reivilibre
0f62973836
Fix AnkiDroid documentation wrt. Media sync url
It does not work if you do not append `/msync/`.
2020-10-28 10:52:10 +00:00
Alexander Bocken
4cf05f7162 improved explanation for AnkiDroid setup 2020-09-05 11:42:44 +02:00
Karsten Lehmann
7deda95d77
Removed whole section about ankisyncd without pyaudio from the README 2020-09-02 18:53:24 +02:00
Karsten Lehmann
65e9bbf747
Updated docs about installation of requirements 2020-09-02 18:53:24 +02:00
Karsten Lehmann
3ec37ec80f
Removed artifact from README 2020-09-02 18:53:24 +02:00
Karsten Lehmann
70bfaa1719
Further clarified configuration for Nginx proxy 2020-09-02 18:53:24 +02:00
Karsten Lehmann
537bbe89c9
updated readme to reflect latest changes 2020-09-02 18:53:24 +02:00
Vikash Kothary
a0eed872de Add gitterchat markdown badge 2020-07-30 21:34:37 +01:00
Vikash Kothary
1331903c9f Add readthedocs markdown badge 2020-07-30 21:34:24 +01:00
Karsten Lehmann
9fde78ec7e
fix: Link to 2.1 addon folder in Readme 2020-06-08 23:04:05 +02:00
flan
02fecc4e0a Clarify wording (development headers)
Should make #29 less likely to happen
2019-03-14 01:13:52 +01:00
flan
7fe7b97475 Update anki-bundled to 2.1.11 2019-03-14 01:09:02 +01:00
flan
9986266b07 Update table of contents 2019-03-14 00:48:13 +01:00
Anton Melser
6c82bad882 Add commented examples to conf file and update Readme.md 2019-03-09 14:08:16 +08:00
flan
bfeaeae2e5 Credit dsnopek 2019-03-08 21:54:54 +01:00
tsudoko
e3e362707a
Add table of contents to README 2019-03-08 20:46:42 +00:00
Anton Melser
75fecf6e6f Add support for setting/overriding config from envvars
This is practical for environments like docker/kubernetes
2019-03-08 15:11:32 +08:00
flan
35f89af98e Update pyaudio instructions 2019-03-07 21:51:11 +01:00
flan
3266cc4282 Update anki-bundled to 2.1.10 2019-03-07 21:41:38 +01:00
flan
91b022eda6 Add AnkiDroid setup instructions
Thanks @luoliyan

Source: https://github.com/tsudoko/anki-sync-server/pull/22#issuecomment-461012296
2019-03-07 05:50:42 +01:00
flan
b1157bac25 Add link to Docker instructions
Fixes #16
2019-02-05 00:35:03 +01:00
flan
bb1dba1b99 Update addon folder
It depends on the platform anyway, and the directory in the README
was outdated anyway (57c8e43327).
2018-12-24 17:19:15 +01:00
flan
537c4daa94 Make potential future instances of #8 easier to debug
With hostNum prepended to the address, the client won't even be
able to connect and will return an error message with the invalid
address.

Example:
    requests.exceptions.InvalidSchema: No connection adapters were found for '6http://localhost:27701/sync/meta'
2018-12-24 16:38:10 +01:00
flan
360b2d08ed Make hostNum empty when changing sync server
Should fix an error encountered when the user used AnkiWeb in the
past and receives a JSON decode error because an unrecognized
endpoint (/[somenumber]sync instead of /sync) doesn't return what
the client expects.

Closes #10, fixes #8.
2018-12-24 16:28:34 +01:00
flan
00ec46eab3 Clarify what the supported version range applies to 2018-12-17 16:58:09 +01:00
flan
8b832497b4 Update anki-bundled to 2.1.7 2018-12-17 16:51:45 +01:00
flan
56beb0950e Update anki-bundled to 2.1.3 2018-08-31 04:39:50 +02:00
flan
5bcb01bd9e Use predefined config locations 2018-08-28 17:15:40 +02:00
flan
b96f74224b Move pyaudio stuff to the bottom 2018-08-23 16:28:27 +02:00