annotate config.urllog.example @ 301:916618770490

urllog: Make ordering of the configuration bit saner.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 27 Jan 2015 08:24:13 +0200
parents 2a9ee3f68225
children f487cc166714
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
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
14 set urllog_log_channels "#tnsp;#fireball;#mazmlame"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
15
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
16
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
17 # Filename of the SQLite URL database file
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
18 set urllog_db_file "urllog.sqlite"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
19
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 # 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
22 # 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
23 set urllog_verbose 1
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
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
26 # 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
27 # 0 = Don't.
267
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
28 set urllog_log_enable 1
263
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
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
31 # 1 = Check URLs for validity and existence before adding.
267
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
32 # 0 = No checks. Add almost _anything_ that looks like an URL to the database.
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
33 # (You probably want this enabled.)
da239a953e24 urllog: Change some setting names, etc.
Matti Hamalainen <ccr@tnsp.org>
parents: 264
diff changeset
34 set urllog_extra_checks 1
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
35
300
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
36 ### Check if the TLD (top level domain) looks sane
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
37 set urllog_check_tld 1
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
38
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
39 # The valid known Top Level Domains (TLDs), but not the country code TLDs
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
40 set urllog_tld_list "org,com,net,mil,gov,biz,edu,coop,aero,info,museum,name,pro,int,xxx"
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
41
2a9ee3f68225 urllog: Make TLD check configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 299
diff changeset
42
299
1ff281e821a3 urllog: Make rasiatube hack configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 277
diff changeset
43 ### Enable "rasiatube" hack that de-mangles rasiatube links
1ff281e821a3 urllog: Make rasiatube hack configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 277
diff changeset
44 set urllog_rasiatube_hack 1
1ff281e821a3 urllog: Make rasiatube hack configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 277
diff changeset
45
1ff281e821a3 urllog: Make rasiatube hack configurable.
Matti Hamalainen <ccr@tnsp.org>
parents: 277
diff changeset
46
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
47 ### 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
48 # (Valid alternatives are "PRIVMSG" and "NOTICE")
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
49 set urllog_preferredmsg "PRIVMSG"
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
50
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
51
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 ### Search related settings
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
54 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
55
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
56 # Channels where !urlfind and other commands can be used.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
57 # 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
58 set urllog_search_channels $urllog_log_channels
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
59
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
60 # 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
61 set urllog_showmax_pub 3
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
62
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
63 # Same as above, but for private message search.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
64 set urllog_showmax_priv 6
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
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 ### ShortURL-settings
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
69 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
70 # 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
71 # URL redirector PHP script (urlredirect.php) correctly, and
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
72 # enable change the settings in it and below appropriately.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
73 # See urlredirect.php.txt for more information.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
74 #
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
75 # You will also need SQLite3 support for PHP and access to
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
76 # change .htaccess file(s) on your web server. The PHP
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
77 # script will also need access to the SQLite3 database this
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
78 # script uses.
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
79 #
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
80
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
81 # 1 = Enable showing of ShortURLs
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
82 # 0 = ShortURLs not shown in any bot actions
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
83 set urllog_shorturl 1
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
84
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
85 # 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
86 # 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
87 set urllog_shorturl_orig 30
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
88
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
89 # Web server URL that handles redirects of ShortURLs
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
90 set urllog_shorturl_prefix "http://tnsp.org/u/"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
91
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
92
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
93 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
94 ### Message texts (informal, errors, etc.)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
95 ###
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
96
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
97 # No such host was found
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
98 set urlmsg_nosuchhost "ei tommosta oo!"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
99
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
100 # Could not connect host (I/O errors etc)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
101 set urlmsg_ioerror "kraak, virhe yhdynnässä."
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
102
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
103 # HTTP timeout
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
104 set urlmsg_timeout "ei jaksa ootella"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
105
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
106 # No such document was found
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
107 set urlmsg_errorgettingdoc "siitosvirhe"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
108
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
109 # URL was already known (was in database)
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
110 set urlmsg_alreadyknown "wanha!"
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
111 #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."
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
112
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
113 # 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
114 set urlmsg_nomatch "Ei osumia."
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
115
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
116
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
117 ###
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
118 ### HTTP options
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
119 ###
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
120 # Set to 1 if you want to enable use of HTTP proxy.
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
121 # If you do, you MUST set the proxy settings below too.
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
122 set http_use_proxy 0
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
123
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
124 # Proxy host and port number (only used if enabled above)
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
125 set http_proxy_host ""
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
126 set http_proxy_port 8080
263
f01d60175c44 urllog: Move configuration to external file.
Matti Hamalainen <ccr@tnsp.org>
parents:
diff changeset
127
301
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
128 # Enable _experimental_ TLS/SSL support. This may not work at all.
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
129 # If unsure, leave this option disabled (0).
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
130 set http_tls_support 1
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
131
916618770490 urllog: Make ordering of the configuration bit saner.
Matti Hamalainen <ccr@tnsp.org>
parents: 300
diff changeset
132 set http_tls_cadir "/usr/share/ca-certificates/mozilla"