annotate config.urllog.example @ 581:148c7553c50f

urllog: Remove rasiatube hack setting, it's not used.
author Matti Hamalainen <ccr@tnsp.org>
date Mon, 04 Jan 2021 12:20:38 +0200
parents ca535e7eb0ed
children 2294b73df2cf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
1 ##########################################################################
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
2 #
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
3 # URLLog script configuration
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
4 #
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
5 ##########################################################################
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
6
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
7 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
8 ### General options
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
9 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
10
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
11 # Channels where URLLog records links/URLs
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
12 # set urllog_log_channels "#foobar;#baz"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
13 # You can use * to match substrings or everything
580
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
14 set urllog_log_channels "*"
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15
315
7a987b22a817 urllog: Add new configuration option urllog_msg_channels.
Matti Hamalainen <ccr@tnsp.org>
parents: 308
diff changeset
16 # Channels where URLLog announces URL titles and so on
7a987b22a817 urllog: Add new configuration option urllog_msg_channels.
Matti Hamalainen <ccr@tnsp.org>
parents: 308
diff changeset
17 # By default we set this to same as urllog_log_channels
7a987b22a817 urllog: Add new configuration option urllog_msg_channels.
Matti Hamalainen <ccr@tnsp.org>
parents: 308
diff changeset
18 set urllog_msg_channels $urllog_log_channels
7a987b22a817 urllog: Add new configuration option urllog_msg_channels.
Matti Hamalainen <ccr@tnsp.org>
parents: 308
diff changeset
19
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
20
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
21 # Filename of the SQLite URL database file
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
22 set urllog_db_file "urllog.sqlite"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
23
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
24
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
25 # 1 = Verbose: Say messages when URL is OK, bad, etc.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 # 0 = Quiet : Be quiet (only speak if asked with !urlfind, etc)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
27 set urllog_verbose 1
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
28
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
29
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
30 # 1 = Enable logging of various script actions into bot's log
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 # 0 = Don't.
267
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
32 set urllog_log_enable 1
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
33
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
34
580
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
35 ### Various additional checks for URL validity: (1 = enabled, 0 = disabled)
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
36 ### This is REQUIRED for document title fetching/storage
267
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
37 set urllog_extra_checks 1
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
38
304
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
39 ### Set to 1 if you want "strict" extra checking. This will cause
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
40 ### ftp URLs not being added, and if TLS support is disabled, https URLs
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
41 ### will not be added either. You probably don't want this set.
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
42 set urllog_extra_strict 0
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
43
f1589fe20732 urllog: Added urllog_extra_strict option.
Matti Hamalainen <ccr@tnsp.org>
parents: 303
diff changeset
44
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
45 ### What IRC "command" should we use to send messages:
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
46 # (Valid alternatives are "PRIVMSG" and "NOTICE")
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
47 set urllog_preferredmsg "PRIVMSG"
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
48
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
49
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
50 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51 ### Search related settings
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
52 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
53
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54 # Channels where !urlfind and other commands can be used.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55 # By default this is set to be the same as urllog_log_channels
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56 set urllog_search_channels $urllog_log_channels
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
58 # Limit how many URLs should the "!urlfind" command show at most.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59 set urllog_showmax_pub 3
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
60
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
61 # Same as above, but for private message search.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62 set urllog_showmax_priv 6
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
63
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
64
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
65 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
66 ### ShortURL-settings
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
67 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
68 # To enable ShortURL functionality, you need to set up the
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
69 # URL redirector PHP script (urlredirect.php) correctly, and
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
70 # enable change the settings in it and below appropriately.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
71 # See urlredirect.php.txt for more information.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
72 #
308
45ada1ddc63b Update comment.
Matti Hamalainen <ccr@tnsp.org>
parents: 305
diff changeset
73 # You will also need DBO support for PHP and access to
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
74 # change .htaccess file(s) on your web server. The PHP
308
45ada1ddc63b Update comment.
Matti Hamalainen <ccr@tnsp.org>
parents: 305
diff changeset
75 # script will also need access to the database this
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
76 # script uses.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
77 #
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
78
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79 # 1 = Enable showing of ShortURLs
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
80 # 0 = ShortURLs not shown in any bot actions
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
81 set urllog_shorturl 1
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
82
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
83 # Max length of original URL to be shown, rest is chopped
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84 # off if the URL is longer than the specified amount.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
85 set urllog_shorturl_orig 30
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
86
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
87 # Web server URL that handles redirects of ShortURLs
580
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
88 set urllog_shorturl_prefix "https://tnsp.org/u/"
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
89
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
90
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
91 ###
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
92 ### HTTP options
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
93 ###
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
94 # Set to 1 if you want to enable use of HTTP proxy.
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
95 # If you do, you MUST set the proxy settings below too.
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
96 set http_use_proxy 0
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
97
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
98 # Proxy host and port number (only used if enabled above)
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
99 set http_proxy_host ""
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
100 set http_proxy_port 8080
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
101
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
102
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
103 # Enable TLS/SSL support. If disabled, https URLs won't be added at all.
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
104 # If you enable this setting, you need to set http_tls_cadir to point to
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
105 # correct location as well!
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
106 set http_tls_support 1
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
107
ca535e7eb0ed urllog: Update example configuration.
Matti Hamalainen <ccr@tnsp.org>
parents: 366
diff changeset
108 set http_tls_cadir "/usr/share/ca-certificates/mozilla"
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
109
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
110
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
111 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
112 ### Message texts (informal, errors, etc.)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
113 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
114
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
115 # No such host was found
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
116 set urlmsg_nosuchhost "ei tommosta oo!"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
117
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
118 # Could not connect host (I/O errors etc)
303
a55beb347bad urllog: Update messages.
Matti Hamalainen <ccr@tnsp.org>
parents: 302
diff changeset
119 set urlmsg_ioerror "kraak, virhe yhdynnässä."
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
120
303
a55beb347bad urllog: Update messages.
Matti Hamalainen <ccr@tnsp.org>
parents: 302
diff changeset
121 # HTTP timeout occured
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
122 set urlmsg_timeout "ei jaksa ootella"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
123
303
a55beb347bad urllog: Update messages.
Matti Hamalainen <ccr@tnsp.org>
parents: 302
diff changeset
124 # No such document was found or other error
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
125 set urlmsg_errorgettingdoc "siitosvirhe"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
126
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
127 # URL was already known (was in database)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
128 set urlmsg_alreadyknown "wanha!"
303
a55beb347bad urllog: Update messages.
Matti Hamalainen <ccr@tnsp.org>
parents: 302
diff changeset
129 #set urlmsg_alreadyknown "Empiiristen havaintojen perusteella ja tällä sovellutusalueella esiintyneisiin aikaisempiin kontekstuaalisiin ilmaisuihin viitaten uskallan todeta, että sovellukseen ilmoittamasi tietoverkko-osoite oli kronologisti ajatellen varsin postpresentuaalisesti sopimaton ja ennestään hyvin tunnettu."
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
130
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
131 # No match was found when searched with !urlfind or other command
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
132 set urlmsg_nomatch "Ei osumia."
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
133
302
f487cc166714 urllog: Add message for unknown TLDs.
Matti Hamalainen <ccr@tnsp.org>
parents: 301
diff changeset
134