source: code/trunk/README.md@ 79

Last change on this file since 79 was 79, checked in by SYNStack, 7 years ago

Change minimum version requirement to Go >= 1.10

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
22Requirement: Go version 1.10 or higher.
23
24```
25$ go get github.com/asciimoo/morty
26$ "$GOPATH/bin/morty" --help
27```
28
29
30### Test
31
32```
33$ cd "$GOPATH/src/github.com/asciimoo/morty"
34$ go test
35```
36
37
38### Benchmark
39
40```
41$ cd "$GOPATH/src/github.com/asciimoo/morty"
42$ go test -benchmem -bench .
43```
44
45
46## Bugs
47
48Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/morty/issues).
49
50
51## [LICENSE](https://github.com/asciimoo/morty/blob/master/LICENSE)
Note: See TracBrowser for help on using the repository browser.