
Signed-off-by: Izuru Yakumo <yakumo.izuru@chaotic.ninja> git-svn-id: file:///srv/svn/repo/yukari/trunk@150 f3bd38d9-da89-464d-a02a-eb04e43141b5
77 lines
2.1 KiB
Groff
77 lines
2.1 KiB
Groff
.\" $TheSupernovaDuo$
|
|
.Dd $Mdocdate$
|
|
.Dt YUKARI 1
|
|
.Os
|
|
.Sh NAME
|
|
.Nm yukari
|
|
.Nd Privacy-aware Web Content Sanitizer Proxy As A Service (WCSPAAS)
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl f Ar string
|
|
.Op Fl proxy Ar string
|
|
.Op Fl proxyenv Ar bool
|
|
.Op Fl socks5 Ar string
|
|
.Op Fl version
|
|
.Sh DESCRIPTION
|
|
Yukari's Gap rewrites web pages to exclude malicious HTML tags and attributes.
|
|
It also replaces external resource references in order to prevent third-party
|
|
information leaks.
|
|
.Pp
|
|
The main goal of Yukari's Gap is to provide a result proxy for SearX, but it
|
|
can be used as a standalone sanitizer service, too.
|
|
.Sh FEATURES
|
|
.Bl -tag -width Ds
|
|
.It HTML sanitization
|
|
.It Rewrites HTML/CSS external references to locals
|
|
.It JavaScript blocking
|
|
.It No Cookies forwarded
|
|
.It No Referrers
|
|
.It No Caching/ETag
|
|
.It Supports GET/POST forms and IFrames
|
|
.It Optional HMAC URL verifier key to prevent service abuse
|
|
.El
|
|
.Sh OPTIONS
|
|
.Bl -tag -width Ds
|
|
.It Fl f Ar path
|
|
Load configuration file from path
|
|
.It Fl proxy Ar string
|
|
Use the specified HTTP proxy (ie: [user:pass@]hostname:port),
|
|
this overrides the
|
|
.Fl socks5
|
|
option and the IPv6 setting
|
|
.It Fl proxyenv Ar bool
|
|
Use a HTTP proxy as set in the environment (such as
|
|
.Ev HTTP_PROXY ,
|
|
.Ev HTTPS_PROXY ,
|
|
.Ev NO_PROXY
|
|
).
|
|
Overrides the
|
|
.Fl proxy ,
|
|
.Fl socks5 ,
|
|
flags and the IPv6 setting
|
|
.It Fl socks5 Ar string
|
|
Use a SOCKS5 proxy (ie: hostname:port), this
|
|
overrides the IPv6 setting
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr SearX 1
|
|
.Sh AUTHORS
|
|
.An Adam Tauber Aq Mt asciimoo@gmail.com
|
|
.An Alexandre Flament Aq Mt alex@al-f.net
|
|
.Sh MAINTAINERS
|
|
.An Izuru Yakumo Aq Mt yakumo.izuru@chaotic.ninja
|
|
.Sh BUGS
|
|
Bugs or suggestions?
|
|
Send an email to
|
|
.Aq Mt yukari-dev@chaotic.ninja
|
|
.Sh LICENSE
|
|
This program is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU Affero General Public License as published
|
|
by the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
.Pp
|
|
This program is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
|
|
PARTICULAR PURPOSE.
|
|
See the GNU Affero General Public License for more details.
|