source: code/trunk/README.md@ 92

Last change on this file since 92 was 87, checked in by asciimoo, 7 years ago

Merge pull request #65 from SYNStack/readme-travis-oops

Fixed typo in travis badge

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