forked from wabarc/wayback
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wayback.1
319 lines (310 loc) · 7.33 KB
/
wayback.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
.\" Manpage for wayback.
.TH "WAYBACK" "5" "April, 2022" "\ \&" "\ \&"
.SH NAME
wayback \- easy and fast to wayback webpage.
.SH SYNOPSIS
\fBwayback\fR [--chatid] [-d|--daemon] [--debug] [-h|--help] [--ia] [--ip] [--is]
[--ipfs-host] [-m|--ipfs-mode] [-p|--ipfs-port]
[-t|--token] [--tor] [--tor-key]
[-c|--config] [--info] [--print]
[-v|--version]
.SH EXAMPLES
\fBwayback\fR https://www.eff.org https://www.fsf.org
.br
\fBwayback\fR --ia --is -d telegram -t your-telegram-bot-token
.SH DESCRIPTION
\fBwayback\fR is a toolkit for snapshot webpage to Internet Archive, archive.today, IPFS and beyond.
.SH OPTIONS
.PP
.B \-\-chatid
.RS 4
The Telegram public/private channel id to publish archive result\&.
.RE
.PP
.B \-d, \-\-daemon
.RS 4
Run as daemon service, e.g. telegram, web\&.
.RE
.PP
.B \-c, \-\-config
.RS 4
Configuration file path, defaults: ./wayback.conf, ~/wayback.conf, /etc/wayback.conf\&.
.RE
.PP
.B \-\-debug
.RS 4
Enable debug mode. default: false\&.
.RE
.PP
.B \-\-print
.RS 4
Show application configurations. default: false\&.
.RE
.PP
.B \-\-info
.RS 4
Show application information. default: false\&.
.RE
.PP
.B \-h, \-\-help
.RS 4
help for wayback\&.
.RE
.PP
.B \-\-ia
.RS 4
Wayback webpages to Internet Archive\&.
.RE
.PP
.B \-\-ip
.RS 4
Wayback webpages to IPFS. default: false\&.
.RE
.PP
.B \-\-ipfs\-host
.RS 4
IPFS daemon service's host, do not require, unless enable ipfs. default "127.0.0.1"\&.
.RE
.PP
.B \-m, \-\-ipfs\-mode
.RS 4
IPFS mode for preserve webpage, currently supports are daemon and pinner, for the daemon mode which
.br
required run an IPFS service daemon process extra, for the pinner mode which does not require any
.br
third-party program. Uses pinner mode, also can take infura or pinata as pinner service,
.br
more detail on
.UR
https://github.com/wabarc/ipfs-pinner\&.
.RE
.PP
.B \-p, \-\-ipfs\-port
.RS 4
IPFS daemon port. default 5001\&.
.RE
.PP
.B \-t, \-\-token
.RS 4
Telegram Bot API Token\&.
.RE
.PP
.B \-\-tor
.RS 4
Snapshot webpage via Tor proxy\&.
.RE
.PP
.B \-\-tor-key
.RS 4
The private key for Tor hidden service\&.
.RE
.PP
.B \-v, \-\-version
.RS 4
version for wayback\&.
.RE
.SH ENVIRONMENT
.TP
.B DEBUG
Set the value to 1 to enable debug logs, override "LOG_LEVEL"\&.
.TP
.B LOG_TIME
Display the date and time in log messages\&.
.TP
.B LOG_LEVEL
Log level, supported level are "debug", "info", "warn", "error", "fatal", defaults to "info"\&.
.TP
.B ENABLE_METRICS
Enable metrics collector\&.
.TP
.B WAYBACK_LISTEN_ADDR
The listen address for the HTTP server. default "0.0.0.0:8964"\&.
.TP
.B CHROME_BIN
Preferred to sets the path to the Chrome executable\&.
.TP
.B CHROME_REMOTE_ADDR
Chrome/Chromium remote debugging address, for screenshot\&.
.TP
.B WAYBACK_IPFS_HOST
IPFS daemon service's host, do not require, unless enable ipfs. default "127.0.0.1". (same as flag --ipfs-host)\&.
.TP
.B WAYBACK_IPFS_PORT
IPFS daemon port. default 5001. (same as flag --ipfs-port)\&.
.TP
.B WAYBACK_IPFS_MODE
IPFS mode for preserve webpage. default: "pinner". (same as flag --ipfs-mode)\&.
.TP
.B WAYBACK_IPFS_TARGET
The IPFS pinning service is used to store files\&.
.TP
.B WAYBACK_IPFS_APIKEY
Apikey of the IPFS pinning service\&.
.TP
.B WAYBACK_IPFS_SECRET
Secret of the IPFS pinning service\&.
.TP
.B WAYBACK_USE_TOR
Snapshot webpage via Tor proxy. (same as flag --tor)\&.
.TP
.B WAYBACK_ENABLE_IA
Enable Internet Archive\&.
.TP
.B WAYBACK_ENABLE_IS
Enable Archive Today (archive.is)\&.
.TP
.B WAYBACK_ENABLE_IP
Enable IPFS\&.
.TP
.B WAYBACK_POOLING_SIZE
Number of worker pool for wayback at once. default 3\&.
.TP
.B WAYBACK_TIMEOUT
Timeout for single wayback request, default 300\&.
.TP
.B WAYBACK_MAX_RETRIES
Max retries for single wayback request, default 2\&.
.TP
.B WAYBACK_USERAGENT
User-Agent for a wayback request, default WaybackArchiver/1.0\&.
.TP
.B WAYBACK_FALLBACK
Use Google cache as a fallback if the original webpage is unavailable, default "off"\&.
.TP
.B WAYBACK_MEILI_ENDPOINT
Meilisearch API endpoint.\&.
.TP
.B WAYBACK_MEILI_INDEXING
Meilisearch indexing name.\&.
.TP
.B WAYBACK_MEILI_APIKEY
Meilisearch admin API key.\&.
.TP
.B WAYBACK_BOLT_PATH
File path of bolt database. default ./wayback.db\&.
.TP
.B WAYBACK_STORAGE_DIR
Directory to store binary file, e.g. PDF, html file\&.
.TP
.B WAYBACK_MAX_MEDIA_SIZE
Max size to limit download stream media. default 512MB\&.
.TP
.B WAYBACK_MEDIA_SITES
Extra media websites wish to be supported, separate with comma\&.
.TP
.B WAYBACK_TELEGRAM_TOKEN
Telegram Bot API Token. (same as flag --token)\&.
.TP
.B WAYBACK_TELEGRAM_CHANNEL
The chatid which publish message. (same as flag --chatid)\&.
.TP
.B WAYBACK_TELEGRAM_HELPTEXT
The help text for Telegram bot command\&.
.TP
.B WAYBACK_ONION_PRIVKEY
The private key for Tor service. (same as flag --tor-key)\&.
.TP
.B WAYBACK_MASTODON_SERVER
Domain of Mastodon instance\&.
.TP
.B WAYBACK_MASTODON_KEY
The client key of your Mastodon application\&.
.TP
.B WAYBACK_MASTODON_SECRET
The client secret of your Mastodon application\&.
.TP
.B WAYBACK_MASTODON_TOKEN
The access token of your Mastodon application\&.
.TP
.B WAYBACK_TWITTER_CONSUMER_KEY
The customer key of your Twitter application\&.
.TP
.B WAYBACK_TWITTER_CONSUMER_SECRET
The customer secret of your Twitter application\&.
.TP
.B WAYBACK_TWITTER_ACCESS_TOKEN
The access token of your Twitter application\&.
.TP
.B WAYBACK_TWITTER_ACCESS_SECRET
The access secret of your Twitter application\&.
.TP
.B WAYBACK_DISCORD_BOT_TOKEN
Discord bot authorization token\&.
.TP
.B WAYBACK_DISCORD_CHANNEL
Discord channel ID\&.
.TP
.B WAYBACK_SLACK_APP_TOKEN
App-Level Token of Slack app\&.
.TP
.B WAYBACK_SLACK_BOT_TOKEN
`Bot User OAuth Token` for Slack workspace, use `User OAuth Token` if requires create external link\&.
.TP
.B WAYBACK_SLACK_CHANNEL
Channel ID of Slack channel\&.
.TP
.B WAYBACK_SLACK_HELPTEXT
The help text for Slack slash command\&.
.TP
.B WAYBACK_XMPP_JID
The JID of a XMPP account\&.
.TP
.B WAYBACK_XMPP_PASSWORD
The password of a XMPP account\&.
.TP
.B WAYBACK_XMPP_NOTLS
Connect to XMPP server without TLS\&.
.TP
.B WAYBACK_XMPP_HELPTEXT
The help text for XMPP command\&.
.TP
.B WAYBACK_GITHUB_TOKEN
GitHub Personal Access Token, required the `repo` scope\&.
.TP
.B WAYBACK_GITHUB_OWNER
GitHub account name\&.
.TP
.B WAYBACK_GITHUB_REPO
GitHub repository to publish results\&.
.TP
.B WAYBACK_NOTION_TOKEN
Notion integration token\&.
.TP
.B WAYBACK_NOTION_DATABASE_ID
Notion database ID for archiving results\&.
.TP
.B WAYBACK_NOSTR_RELAY_URL
Nostr relay server url, multiple separated by comma\&.
.TP
.B WAYBACK_NOSTR_PRIVATE_KEY
The private key of a Nostr account\&.
.TP
.B WAYBACK_ONION_LOCAL_PORT
Local port of Tor service. This is ignored if `WAYBACK_LISTEN_ADDR` is set.\&.
.TP
.B WAYBACK_ONION_REMOTE_PORTS
Remote ports of Tor hidden service, e.g. WAYBACK_ONION_REMOTE_PORTS=80,81\&.
.TP
.B WAYBACK_ONION_DISABLED
Disable onion service. default: false\&.
.TP
.B WAYBACK_SLOT
Pinning service for IPFS mode of pinner, see
.UR
https://github.com/wabarc/ipfs-pinner#supported-pinning-services\&.
.TP
.B WAYBACK_APIKEY
API key for pinning service\&.
.TP
.B WAYBACK_SECRET
API secret for pinning service\&.
.SH BUGS
.P
To view a list of known bugs, or to enter a bug report, please use
Wayback's issue tracker: <https://github.com/wabarc/wayback/issues>
.SH AUTHORS
.P
Wayback is written and maintained by Wayback Archiver\&.
.SH "COPYRIGHT"
.P
Wayback is released under the terms of the GNU General Public License v3.0\&.