| 1 | .\" $TheSupernovaDuo$
|
|---|
| 2 | .Dd $Mdocdate$
|
|---|
| 3 | .Dt YUKARI 1
|
|---|
| 4 | .Os
|
|---|
| 5 | .Sh NAME
|
|---|
| 6 | .Nm yukari
|
|---|
| 7 | .Nd Privacy-aware Web Content Sanitizer Proxy As A Service (WCSPAAS)
|
|---|
| 8 | .Sh SYNOPSIS
|
|---|
| 9 | .Nm
|
|---|
| 10 | .Op Fl f Ar string
|
|---|
| 11 | .Op Fl proxy Ar string
|
|---|
| 12 | .Op Fl proxyenv Ar bool
|
|---|
| 13 | .Op Fl socks5 Ar string
|
|---|
| 14 | .Op Fl version
|
|---|
| 15 | .Sh DESCRIPTION
|
|---|
| 16 | Yukari's Gap rewrites web pages to exclude malicious HTML tags and attributes.
|
|---|
| 17 | It also replaces external resource references in order to prevent third-party
|
|---|
| 18 | information leaks.
|
|---|
| 19 | .Pp
|
|---|
| 20 | The main goal of Yukari's Gap is to provide a result proxy for SearX, but it
|
|---|
| 21 | can be used as a standalone sanitizer service, too.
|
|---|
| 22 | .Sh FEATURES
|
|---|
| 23 | .Bl -tag -width Ds
|
|---|
| 24 | .It HTML sanitization
|
|---|
| 25 | .It Rewrites HTML/CSS external references to locals
|
|---|
| 26 | .It JavaScript blocking
|
|---|
| 27 | .It No Cookies forwarded
|
|---|
| 28 | .It No Referrers
|
|---|
| 29 | .It No Caching/ETag
|
|---|
| 30 | .It Supports GET/POST forms and IFrames
|
|---|
| 31 | .It Optional HMAC URL verifier key to prevent service abuse
|
|---|
| 32 | .El
|
|---|
| 33 | .Sh OPTIONS
|
|---|
| 34 | .Bl -tag -width Ds
|
|---|
| 35 | .It Fl f Ar path
|
|---|
| 36 | Load configuration file from path
|
|---|
| 37 | .It Fl proxy Ar string
|
|---|
| 38 | Use the specified HTTP proxy (ie: [user:pass@]hostname:port),
|
|---|
| 39 | this overrides the
|
|---|
| 40 | .Fl socks5
|
|---|
| 41 | option and the IPv6 setting
|
|---|
| 42 | .It Fl proxyenv Ar bool
|
|---|
| 43 | Use a HTTP proxy as set in the environment (such as
|
|---|
| 44 | .Ev HTTP_PROXY ,
|
|---|
| 45 | .Ev HTTPS_PROXY ,
|
|---|
| 46 | .Ev NO_PROXY
|
|---|
| 47 | ).
|
|---|
| 48 | Overrides the
|
|---|
| 49 | .Fl proxy ,
|
|---|
| 50 | .Fl socks5 ,
|
|---|
| 51 | flags and the IPv6 setting
|
|---|
| 52 | .It Fl socks5 Ar string
|
|---|
| 53 | Use a SOCKS5 proxy (ie: hostname:port), this
|
|---|
| 54 | overrides the IPv6 setting
|
|---|
| 55 | .El
|
|---|
| 56 | .Sh SEE ALSO
|
|---|
| 57 | .Xr SearX 1
|
|---|
| 58 | .Sh AUTHORS
|
|---|
| 59 | .An Adam Tauber Aq Mt asciimoo@gmail.com
|
|---|
| 60 | .An Alexandre Flament Aq Mt alex@al-f.net
|
|---|
| 61 | .Sh MAINTAINERS
|
|---|
| 62 | .An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
|
|---|
| 63 | .Sh BUGS
|
|---|
| 64 | Bugs or suggestions?
|
|---|
| 65 | Send an email to
|
|---|
| 66 | .Aq Mt yukari-dev@chaotic.ninja
|
|---|
| 67 | .Sh LICENSE
|
|---|
| 68 | This program is free software: you can redistribute it and/or modify it
|
|---|
| 69 | under the terms of the GNU Affero General Public License as published
|
|---|
| 70 | by the Free Software Foundation, either version 3 of the License, or
|
|---|
| 71 | (at your option) any later version.
|
|---|
| 72 | .Pp
|
|---|
| 73 | This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
|---|
| 74 | WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
|---|
| 75 | PARTICULAR PURPOSE.
|
|---|
| 76 | See the GNU Affero General Public License for more details.
|
|---|
