source: code/trunk/yukari.1@ 144

Last change on this file since 144 was 142, checked in by Izuru Yakumo, 22 months ago

Rebrand to Yukari's Gap

Signed-off-by: Izuru Yakumo <yakumo.izuru@…>

File size: 1.7 KB
RevLine 
[142]1.TH MORTY "1" "2018" "yukari" "User Commands"
2.SH NAME
3yukari \- Privacy aware web content sanitizer proxy as a service
4.SH SYNOPSIS
5.B yukari
6.RI [ OPTIONS ]
7.br
8.SH DESCRIPTION
9Yukari rewrites web pages to exclude malicious HTML tags and attributes. It
10also replaces external resource references to prevent third party
11information leaks.
12.sp
13The main goal of yukari is to provide a result proxy for searx, but it can be
14used as a standalone sanitizer service too.
15.SH OPTIONS
16.HP
17\fB\-ipv6\fR
18.IP
19Allow IPv6 HTTP requests
20.HP
21\fB\-key\fR string
22.IP
23HMAC url validation key (hexadecimal encoded) \- leave blank to disable
24.HP
25\fB\-listen\fR string
26.IP
27Listen address (default "127.0.0.1:3000")
28.HP
29\fB\-timeout\fR uint
30.IP
31Request timeout (default 2)
32.HP
33\fB\-version\fR
34.IP
35Show version
36.SH BUGS
37Bugs or suggestions? Visit the issue tracker at
38https://git.chaotic.ninja/yakumo.izuru/yukari/issues.
39.SH SEE ALSO
40.BR searx (1)
41.SH LICENSE
42Copyright 2023-present Izuru Yakumo <yakumo.izuru@chaotic.ninja>
43.br
44Copyright 2016-2018 Adam Tauber <asciimoo@gmail.com>
45.br
46Copyright 2016 Alexandre Flament <alex@al-f.net>
47.sp
48This program is free software: you can redistribute it and/or modify it under
49the terms of the GNU Affero General Public License as published by the Free
50Software Foundation, either version 3 of the License, or (at your option) any
51later version.
52.sp
53This program is distributed in the hope that it will be useful, but WITHOUT ANY
54WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
55PARTICULAR PURPOSE. See the GNU Affero General Public License for more
56details.
57.sp
58You should have received a copy of the GNU Affero General Public License along
59with this program. If not, see <http://www.gnu.org/licenses/>.
Note: See TracBrowser for help on using the repository browser.