source: code/trunk/README.md@ 55

Last change on this file since 55 was 48, checked in by asciimoo, 9 years ago

[doc] add test/benchmark/license info

File size: 1.1 KB
Line 
1# Morty
2
3Web content sanitizer proxy as a service
4
5Morty rewrites web pages to exclude malicious HTML tags and attributes. It also replaces external resource references to prevent third party information leaks.
6
7The main goal of morty is to provide a result proxy for [searx](https://asciimoo.github.com/searx/), but it can be used as a standalone sanitizer service too.
8
9Features:
10
11 - HTML sanitization
12 - Rewrites HTML/CSS external references to locals
13 - JavaScript blocking
14 - No Cookies forwarded
15 - No Referrers
16 - No Caching/Etag
17 - Supports GET/POST forms and IFrames
18 - Optional HMAC URL verifier key to prevent service abuse
19
20
21## Installation and setup
22
23```
24$ go get github.com/asciimoo/morty
25$ "$GOPATH/bin/morty" --help
26```
27
28
29### Test
30
31```
32$ cd "$GOPATH/src/github.com/asciimoo/morty"
33$ go test
34```
35
36
37### Benchmark
38
39```
40$ cd "$GOPATH/src/github.com/asciimoo/morty"
41$ go test -benchmem -bench .
42```
43
44
45## Bugs
46
47Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/morty/issues).
48
49
50## [LICENSE](https://github.com/asciimoo/morty/blob/master/LICENSE)
Note: See TracBrowser for help on using the repository browser.