yukari/README.md
asciimoo de8b3c4c47 Merge pull request #64 from SYNStack/readme-travis
Add travis build status to README

git-svn-id: file:///srv/svn/repo/yukari/trunk@82 f3bd38d9-da89-464d-a02a-eb04e43141b5
2018-09-06 19:40:35 +00:00

54 lines
1.2 KiB
Markdown

# Morty
[![Build Status](https://travis-ci.org/asciimoo/morty.svg)](https://travis-ci.org/ascimoo/morty)
Web content sanitizer proxy as a service
Morty rewrites web pages to exclude malicious HTML tags and attributes. It also replaces external resource references to prevent third party information leaks.
The 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.
Features:
- HTML sanitization
- Rewrites HTML/CSS external references to locals
- JavaScript blocking
- No Cookies forwarded
- No Referrers
- No Caching/Etag
- Supports GET/POST forms and IFrames
- Optional HMAC URL verifier key to prevent service abuse
## Installation and setup
Requirement: Go version 1.10 or higher.
```
$ go get github.com/asciimoo/morty
$ "$GOPATH/bin/morty" --help
```
### Test
```
$ cd "$GOPATH/src/github.com/asciimoo/morty"
$ go test
```
### Benchmark
```
$ cd "$GOPATH/src/github.com/asciimoo/morty"
$ go test -benchmem -bench .
```
## Bugs
Bugs or suggestions? Visit the [issue tracker](https://github.com/asciimoo/morty/issues).
## [LICENSE](https://github.com/asciimoo/morty/blob/master/LICENSE)