source: code/trunk/README.md@ 152

Last change on this file since 152 was 150, checked in by Izuru Yakumo, 15 months ago

えー

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File size: 1.4 KB
RevLine 
[147]1# Yukari's Gap
[150]2Web content sanitizer proxy as a service[^1], fork of [MortyProxy](https://github.com/asciimoo/morty) with some suggestions from the issue tracker applied, named after [the youkai you shouldn't ever come near](https://en.touhouwiki.net/wiki/Yukari_Yakumo)
[1]3
[147]4Yukari's Gap rewrites web pages to exclude malicious HTML tags and attributes. It also replaces external resource references to prevent third party information leaks.
[1]5
[147]6The main goal of this tool is to provide a result proxy for [searx](https://asciimoo.github.com/searx/), but it can be used as a standalone sanitizer service too.
[1]7
[6]8Features:
[1]9
[147]10* HTML sanitization
11* Rewrites HTML/CSS external references to locals
12* JavaScript blocking
13* No Cookies forwarded
14* No Referrers
15* No Caching/Etag
16* Supports GET/POST forms and IFrames
17* Optional HMAC URL verifier key to prevent service abuse
[1]18
19## Installation and setup
[149]20Requirement: Go version 1.16 or higher (thus making it incompatible with MortyProxy's own requirement, but also to use `go embed`)
[1]21
22```
[149]23$ go install marisa.chaotic.ninja/yukari/cmd/yukari@latest
[142]24$ "$GOPATH/bin/yukari" --help
[1]25```
[138]26### Usage
[149]27See `yukari(1)`
[138]28
[48]29### Test
30
31```
[150]32$ make test
[48]33```
34
35### Benchmark
36
37```
[150]38$ make bench
[48]39```
40
[1]41## Bugs
[149]42Bugs or suggestions? Mail [yukari-dev@chaotic.ninja](mailto:yukari-dev@chaotic.ninja)
[150]43
44---
45
46[^1]: or WCPaaS, mind you, also I didn't come up with that, it was already there when I arrived
Note: See TracBrowser for help on using the repository browser.