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