ouczbs/anki-sync-server
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #142 from izidormatusov/sslproxy

Browse Source
This commit is contained in:
Vikash Kothary 2022-10-13 21:32:30 +03:00 committed by GitHub
commit 50bc229708
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -59,32 +59,37 @@ Installing
$ python -m ankisyncd_cli adduser <username> $ python -m ankisyncd_cli adduser <username>
4. Setup a proxy to trans-write the requests (Optional) . 4. Ankisyncd can serve the requests directly. However, if you want better
Ankisyncd currently support the header "Transfer-Encoding: chunked" used by Anki. security and SSL encryption, a proxy can be set up.
If you want to enable secure connection or have a better security,a proxy can be set up.
For example, if you use Nginx on the same machine as ankisyncd, you first
have to change the port in `ankisyncd.conf` to something other than `27701`.
Then configure Nginx to listen on port `27701` and forward the unchunked
requests to ankisyncd.
An example configuration with ankisyncd running on the same machine as Nginx For example, you can use Nginx. First, obtain the SSL certificate from
and listening on port `27702` may look like ([entire config template click me](docs/src/nginx/nginx.example.conf)): [Let's Encrypt](https://letsencrypt.org) via
[certbot](https://certbot.eff.org/). Nginx will accept the requests at
standard HTTPS port 443 and forward the traffic to ankisyncd which runs by
default on port `27701` ([configuration](#configuration)).
An example of configuration for domain `example.com`:
```nginx ```nginx
server { server {
listen 27701; listen 443 ssl;
server_name default; server_name example.com;
# Configuration managed by Certbot
ssl_certificate /etc/letsencrypt/live/example.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/example.com/privkey.pem;
include /etc/letsencrypt/options-ssl-nginx.conf;
location / { location / {
proxy_http_version 1.0; proxy_http_version 1.0;
proxy_pass http://127.0.0.1:27702/; proxy_pass http://127.0.0.1:27702/;
client_max_body_size 222M; client_max_body_size 222M;
} }
} }
``` ```
Adding the line `client_max_body_size 222M;` to Nginx prevents bigger collections from not being able to sync due to size limitations. Adding the line `client_max_body_size 222M;` to Nginx prevents bigger
collections from not being able to sync due to size limitations.
5. Run ankisyncd: 5. Run ankisyncd: