Skip to content

Commit 628c761

Browse files
committed
upd: readme
1 parent a967ee4 commit 628c761

File tree

2 files changed

+18
-2
lines changed

2 files changed

+18
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,18 @@ Image with [privoxy](https://www.privoxy.org) enabled and configured to work wit
77
It also includes '[adblock2privoxy](https://github.com/essandess/adblock2privoxy)' to translate adblock rules to privoxy with CSS hidden elements & blackhole.
88
This means that this image also includes an nginx server so that the advanced CSS rules work correctly.
99

10-
**The default configuration is intended for personal use only (ex. raspberry)**
11-
1210
## :bulb: Documentation
1311

1412
This image downloads the 'trustedCAs' file from curl.se and also generates the ca-bundle file. So, you only need copy the 'ca-bundle' file and install it on your browser/system.
1513

1614
- Check Privoxy Status: ```https://config.privoxy.org/show-status```
1715
- Check *ab2p* is fully operational (needs privoxy ca-bundle to verify SSL): ```https://<ADBLOCK_CSS_DOMAIN>/ab2p.common.css```
1816

17+
### Notes
18+
19+
- The default configuration is intended for personal use only
20+
- If you use ab2p rules, make sure that the routing to the service is configured correctly. Otherwise, you will experience significant loading delays. You can see a basic example in ```docs/traefik.md```.
21+
1922
### Default Ports
2023

2124
| PORT | Description | Required |

docs/traefik.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
```yaml
2+
...
3+
labels:
4+
...
5+
- traefik.tcp.routers.privoxy-https.rule=HostSNI(`css.privoxy.local`)
6+
- traefik.tcp.routers.privoxy-https.entrypoints=websecure
7+
- traefik.tcp.routers.privoxy-https.tls=true
8+
- traefik.tcp.routers.privoxy-https.tls.certresolver=
9+
- traefik.tcp.routers.privoxy-https.tls.passthrough=true
10+
- traefik.tcp.routers.privoxy-https.service=privoxy-https-service
11+
- traefik.tcp.services.privoxy-https-service.loadbalancer.server.port=443
12+
...
13+
```

0 commit comments

Comments
 (0)