source: code/trunk/README.md@ 81

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

Add travis status to README

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