Commit Graph

293 Commits

Author SHA1 Message Date
Vsevolod Stakhov
cce29af0f6 Add lua sqlite3 module 2016-01-25 15:15:01 +00:00
Vsevolod Stakhov
20df8e568b Rework ratelimits documentation 2016-01-22 18:20:09 +00:00
Vsevolod Stakhov
9c91f8ff3f Slightly fix documentation. 2016-01-19 18:25:59 +00:00
Vsevolod Stakhov
402233b911 Add migration notes 1.0 -> 1.1 2016-01-18 18:11:32 +00:00
Vsevolod Stakhov
b22485f657 Allow processing images urls for SURBL 2016-01-14 13:30:55 +00:00
Vsevolod Stakhov
a2706116f9 Add documentation for new statistics 2016-01-13 07:55:24 +00:00
Vsevolod Stakhov
72c9856de6 Add more details to the guide 2016-01-12 18:19:42 +00:00
Vsevolod Stakhov
bcd1b3861b Update surbl documentation 2016-01-12 14:40:12 +00:00
Vsevolod Stakhov
63950721d0 Start SA migrating guide 2016-01-11 19:10:47 +00:00
Vsevolod Stakhov
36f5aa8bbc Slightly improve documentation style 2016-01-04 14:03:14 +00:00
Andrew Lewis
9eb45b6802 RBL module: remove private_ips setting in favour of local_addrs 2016-01-03 20:15:12 +02:00
Vsevolod Stakhov
fbce349729 Add local_addrs/local_networks option 2016-01-03 17:13:24 +00:00
Vsevolod Stakhov
2375dba898 Remove bloody submodules. 2015-12-31 17:38:02 +00:00
Andrew Lewis
e52cec79ee Fix documentation inaccuracy WRT history_file 2015-12-31 14:11:59 +02:00
Vsevolod Stakhov
9a66359e75 Add lua_fann module 2015-12-21 14:46:13 +00:00
Vsevolod Stakhov
900d9aeca3 Update SA plugin documentation 2015-12-21 09:09:22 +00:00
Vsevolod Stakhov
c0a9a49c32 Merge pull request #453 from fatalbanana/master
Writing rules tutorial: Fix path to rspamd.local.lua
2015-12-20 16:39:03 +00:00
Vsevolod Stakhov
e1b777819b Add some controller's documentation 2015-12-17 19:16:30 +00:00
Vsevolod Stakhov
6eeeb063d8 Add normal worker documentation 2015-12-17 19:01:43 +00:00
Andrew Lewis
ef3a926782 Writing rules tutorial: Fix path to rspamd.local.lua
Also try to tune wording a little
2015-12-17 20:51:43 +02:00
Vsevolod Stakhov
ae9e01debf Mention tutorials part 2015-12-17 11:41:55 +00:00
Vsevolod Stakhov
8235c96ab9 Add writing rules tutorial 2015-12-17 11:35:43 +00:00
Vsevolod Stakhov
2b50cf4941 Add tutorials part 2015-12-17 11:35:33 +00:00
Vsevolod Stakhov
c441c82c28 Add options to limit cores for rspamd 2015-12-11 16:48:52 +00:00
Vsevolod Stakhov
c73e9fc202 Rework ratelimit plugin
- Switch to `rates` instead of old and stupid strings to setup
- Check if a bucket is zero and disable the corresponding limits
- Turn off all buckets by default
- Check either `rcpt` or `user` buckets, not all together
- Document new `rates` and `symbol` options
- Inform user about what buckets are used in the configuration
2015-11-30 16:14:47 +00:00
Vsevolod Stakhov
61ba512c5d Update documentation 2015-11-14 14:33:05 +00:00
Vsevolod Stakhov
de867f0152 Document log_format 2015-11-06 15:48:41 +00:00
Vsevolod Stakhov
b3c76ba413 Update documentation 2015-10-26 09:26:25 +00:00
Vsevolod Stakhov
f163ec3b4f Finish history format rework. 2015-10-24 23:02:59 +01:00
Vsevolod Stakhov
c0646f71d6 Add special hacks to allow static build. 2015-10-21 12:57:12 +01:00
Vsevolod Stakhov
a94488a6eb Update manual page. 2015-10-19 19:07:00 +01:00
Vsevolod Stakhov
c754796783 Fix headers arguments. 2015-10-19 18:44:30 +01:00
Vsevolod Stakhov
0d99380848 Add ability to specify custom headers for rspamc client 2015-10-19 17:16:21 +01:00
Vsevolod Stakhov
d18deb48b8 Fix broken link. 2015-10-14 16:56:43 +01:00
Vsevolod Stakhov
e4731b934c Update documentation. 2015-10-14 16:47:36 +01:00
Vsevolod Stakhov
b9ef6acd98 Update manpages. 2015-10-14 16:42:12 +01:00
Vsevolod Stakhov
c16a377102 Update manpage. 2015-10-05 12:40:12 +01:00
Vsevolod Stakhov
4c2a6e952d Add preliminary documentation for rspamadm. 2015-09-28 16:45:01 +01:00
Vsevolod Stakhov
9d68c6ccf3 Update add header action in the settings. 2015-09-18 01:29:20 +01:00
Vsevolod Stakhov
733274892a Update statistics documentation. 2015-09-18 00:45:05 +01:00
Vsevolod Stakhov
8540372d32 Add migration notes. 2015-09-17 18:59:38 +01:00
Vsevolod Stakhov
21d8c9a4f2 Allow optional multiplier for whitelists. 2015-09-16 17:55:49 +01:00
Vsevolod Stakhov
46313ee3de Add whitelist documentation. 2015-09-15 09:34:41 +01:00
Vsevolod Stakhov
38a6ceb5ff Change separators to commas to avoid issues with ipv6. 2015-09-10 10:55:28 +01:00
Vsevolod Stakhov
42b64a5dde Update roff manual. 2015-09-06 21:56:38 +01:00
Vsevolod Stakhov
5b6b1d2088 Update index. 2015-09-05 17:10:37 +01:00
Vsevolod Stakhov
a696faf449 Add dmarc module documentation. 2015-09-05 17:10:14 +01:00
Vsevolod Stakhov
7599acaaf0 Update rspamc manual page. 2015-09-05 17:01:51 +01:00
Vsevolod Stakhov
f134854580 Fix documentation. 2015-09-02 17:21:47 +01:00
Vsevolod Stakhov
8b06b8d37c Update logger documentation. 2015-09-02 16:58:25 +01:00
Vsevolod Stakhov
af386443b8 Markdown fixes. 2015-08-28 14:47:57 +01:00
Vsevolod Stakhov
527d14729a Markdown fixes. 2015-08-28 14:36:02 +01:00
Vsevolod Stakhov
99562c5800 More improvements to documentation. 2015-08-28 14:25:41 +01:00
Vsevolod Stakhov
ea585b11e5 Add documentation for the changes. 2015-08-28 13:51:49 +01:00
Vsevolod Stakhov
c21f57c1ea Include lua_util to documentation index. 2015-08-25 12:38:24 +01:00
Andrew Lewis
4e8b22d80c Add redirector_domains setting 2015-08-19 18:15:53 +02:00
Vsevolod Stakhov
5c6e7257f8 Implement lua_html methods. 2015-07-23 15:18:54 +01:00
Vsevolod Stakhov
dd34e1ff11 Add lua_mempool documetnation. 2015-07-20 23:49:16 +01:00
Andrew Lewis
d287dea792 Doc fix: phishing strict_domains syntax (reported by @Fullmetal8ender) 2015-07-15 13:17:56 +02:00
Andrew Lewis
6fc23f8fe1 Doc fix: confusing reference to RBL module 2015-07-05 14:41:54 +02:00
Andrew Lewis
3ff0104952 Add DKIM support to RBL module 2015-07-05 13:54:39 +02:00
Andrew Lewis
4bc4b010cf Add whitelist_exception setting to RBL module 2015-06-22 21:53:39 +02:00
Vsevolod Stakhov
fb423e20eb Add documentation for lua_tcp. 2015-05-19 18:38:09 +01:00
Vsevolod Stakhov
b5a8bfe8d9 Add preliminary regexp module documentation. 2015-05-14 19:08:51 +01:00
Vsevolod Stakhov
9c2cf79a2b Add multimap documentation. 2015-05-14 18:33:07 +01:00
Vsevolod Stakhov
8e0c0e9155 Add documentation fro ratelimit module. 2015-05-12 19:17:50 +01:00
Vsevolod Stakhov
dc0119dd77 Add dkim module documentation. 2015-05-09 22:53:59 +01:00
Vsevolod Stakhov
61e18322c7 Add SPF module documentation. 2015-05-09 22:25:25 +01:00
Vsevolod Stakhov
5dbca76a75 Add some documentation. 2015-05-09 22:04:20 +01:00
Vsevolod Stakhov
e4e44044cc Document new option. 2015-05-07 18:25:43 +01:00
Vsevolod Stakhov
2e530b2100 Add documentation for trie module. 2015-04-30 18:52:17 +01:00
Vsevolod Stakhov
e9d8478118 Add documentation for phishing module. 2015-04-30 18:37:10 +01:00
Vsevolod Stakhov
de2d8b5945 Add spamassassin module documentation. 2015-04-28 18:59:30 +01:00
Vsevolod Stakhov
6aa19ec1d8 Add documentation for SURBL module. 2015-04-28 18:32:09 +01:00
Vsevolod Stakhov
1ccc669209 Write options documentation. 2015-04-16 18:22:57 +01:00
Vsevolod Stakhov
30ee4c04be Improve documentation. 2015-04-16 17:19:41 +01:00
Andrew Lewis
ab36c2435b RBL doc: remove misleading (dated) information 2015-04-16 14:17:27 +02:00
Vsevolod Stakhov
b3f8edc14c Fix makefile. 2015-04-15 17:55:16 +01:00
Vsevolod Stakhov
6d54321eb9 Write documentation for lua_url. 2015-04-15 17:49:01 +01:00
Vsevolod Stakhov
7e10d7f43e Document group limits. 2015-04-14 18:32:25 +01:00
Vsevolod Stakhov
80b34ec2ba Add documentation for lua logger. 2015-04-09 18:41:19 +01:00
Vsevolod Stakhov
6707b2c477 Fix documentation targets. 2015-04-09 18:13:27 +01:00
Vsevolod Stakhov
3c73848f79 More fixes to luadoc makefile. 2015-04-09 17:18:17 +01:00
Vsevolod Stakhov
732b7268a7 Add new modules to lua documentation. 2015-04-09 17:13:52 +01:00
Andrew Lewis
f5b98e74b8 RBL: Fix docs 2015-04-05 01:28:06 +02:00
Vsevolod Stakhov
9a01296f34 Merge pull request #243 from fatalbanana/master
RBL: change behaviour of whitelists
2015-04-01 17:25:38 +01:00
Andrew Lewis
cd9a587c39 RBL: change behaviour of whitelists 2015-04-01 17:31:39 +02:00
Vsevolod Stakhov
237263f8e9 Add information about json control block. 2015-03-30 20:12:18 +01:00
Vsevolod Stakhov
776f8af046 Markdown portability. 2015-03-30 19:50:55 +01:00
Vsevolod Stakhov
9784056dec Add protocol description. 2015-03-30 17:48:06 +01:00
Vsevolod Stakhov
d050dc57c4 Fix documentation makefile. 2015-02-26 10:46:09 +00:00
Vsevolod Stakhov
78431987c0 Update documentation. 2015-02-20 16:54:01 +00:00
Andrew Lewis
9e1b3fd96d Since exclude_private_ips requires config to change behaviour now we can make it default true 2015-02-17 13:14:10 +02:00
Andrew Lewis
28f55f0cbe Forgot to update documentation for emails dnsbl 2015-02-17 13:03:41 +02:00
Andrew Lewis
6088c2b15f Make local/private IP exclusions work for all RBL types 2015-02-17 12:48:33 +02:00
Andrew Lewis
da3dbe0097 Use radix for private IP exclusions in rbl.lua
Conflicts:
	src/plugins/lua/rbl.lua
2015-02-16 17:32:29 +02:00
Andrew Lewis
63f9c87ab7 Make local exclusions configurable per-RBL 2015-02-16 11:00:04 +02:00
Andrew Lewis
68cd23a572 Support site-local IP address / subnet exclusions 2015-02-15 22:18:40 +02:00
Andrew Lewis
bab9f14abf Make ignoring private IP space configurable; avoid changing plugin default behaviour 2015-02-14 10:57:18 +02:00
Andrew Lewis
c2a4fda0e3 Rename user to exclude_users and invert logic 2015-02-12 17:12:50 +02:00
Andrew Lewis
a47433fe92 Fix typo 2015-02-11 20:43:01 +02:00
Andrew Lewis
e9c1446f0a Update RBL module: fix indentation; collapse loops; avoid calling for un-needed information; allow disabling RBLs for authenticated users 2015-02-11 15:48:46 +02:00
Andrew Lewis
8663bd63f4 Allow applying settings to authenticated users 2015-02-06 15:39:45 +02:00
Vsevolod Stakhov
93924542f9 Update docs. 2015-01-02 11:09:48 +00:00
Andrew Lewis
0f609dbba2 Fix typo in fuzzy_check.md 2015-01-02 08:49:47 +02:00
Vsevolod Stakhov
c6acedb081 Add documentation for fuzzy_check module. 2015-01-02 00:38:31 +00:00
Vsevolod Stakhov
050d52d903 Add documentation for fuzzy worker. 2014-12-29 16:57:56 +00:00
Vsevolod Stakhov
1b448b1e35 Add workers documentation. 2014-12-25 17:46:15 +00:00
Andrew Lewis
ebba464d74 Fix misinformation in RBL module doc 2014-11-26 21:59:47 +02:00
Vsevolod Stakhov
37f6167c29 Update manual page. 2014-11-25 18:37:32 +00:00
Vsevolod Stakhov
24f64a6ed7 Reduce default number of parallel requests to 8. 2014-10-15 15:29:28 +01:00
Vsevolod Stakhov
aa2f5832f8 Update manual pages. 2014-10-15 14:14:07 +01:00
Vsevolod Stakhov
379332add6 Fix formulas. 2014-10-09 01:24:14 +01:00
Vsevolod Stakhov
6331298e31 Use math environment for formula. 2014-10-09 01:18:26 +01:00
Vsevolod Stakhov
9cd981c8a6 Document one_shot option. 2014-10-09 01:15:06 +01:00
Vsevolod Stakhov
4c520213d8 Add metrics configuration. 2014-10-09 00:50:32 +01:00
Vsevolod Stakhov
8f20ff496c Update documentation. 2014-09-21 18:59:26 +01:00
Vsevolod Stakhov
4adaf7e4b2 Update migration document. 2014-09-11 13:02:01 +01:00
Vsevolod Stakhov
57c3dd7200 Remove pre-historic documentation. 2014-09-11 12:49:01 +01:00
Vsevolod Stakhov
94e99a8241 Some fixes. 2014-09-08 12:22:29 +01:00
Vsevolod Stakhov
8c4d5f256b Add migration notes. 2014-09-08 12:20:15 +01:00
Vsevolod Stakhov
c03d4f50e9 Add ucl documentation to the build. 2014-09-08 09:38:53 +01:00
Vsevolod Stakhov
ec29a6b645 Add doxydown submodule. 2014-09-06 14:43:43 -07:00
Vsevolod Stakhov
9636d9c606 Add lua_task documentation to the build. 2014-09-06 14:25:23 -07:00
Vsevolod Stakhov
55782441ab Add documentation for lua_config. 2014-08-30 10:37:42 -07:00
Vsevolod Stakhov
e2bc2b887f Make more compatible markdown. 2014-08-28 13:59:12 +01:00
Vsevolod Stakhov
d555043165 Document rspamd_ip lua interface. 2014-08-28 13:09:01 +01:00
Vsevolod Stakhov
ffa1a5a6f6 Parse @see keywords. 2014-08-28 13:06:47 +01:00
Vsevolod Stakhov
71669bb049 Fix parsing of comment lines without leading *. 2014-08-28 12:48:00 +01:00
Vsevolod Stakhov
f8ea4bebb4 Style fixes. 2014-08-27 15:14:42 +01:00
Vsevolod Stakhov
3c49610613 More style improvements. 2014-08-27 14:57:27 +01:00
Vsevolod Stakhov
e477d71113 Rework lua document tool.
- Allow @method and @function
- Convert from unordered hash tables to arrays
- Consider perl style guide
2014-08-27 14:14:50 +01:00
Vsevolod Stakhov
2f11881db5 Do not add tabs for lists. 2014-08-26 15:47:35 +01:00
Vsevolod Stakhov
c6537f13a1 Add lua-doc target. 2014-08-26 15:45:24 +01:00
Vsevolod Stakhov
dbd075fa4c Add notes about 'require'. 2014-08-26 15:36:28 +01:00
Vsevolod Stakhov
782759758b Sort markdown entries. 2014-08-26 15:36:08 +01:00
Vsevolod Stakhov
cfccd81669 Add convertor from lua C API to markdown. 2014-08-26 14:43:36 +01:00
Vsevolod Stakhov
c22f671415 Fix notes about settings. 2014-08-23 13:51:46 -07:00
Vsevolod Stakhov
eb1e028d6d Fix tabulation and some spelling. 2014-08-22 15:17:35 +01:00
Vsevolod Stakhov
4735a005ad Fixes to lua api intro. 2014-08-22 14:36:11 +01:00
Vsevolod Stakhov
812ef40c29 Markdown. 2014-08-14 14:07:51 +01:00
Vsevolod Stakhov
ba31993d8c Markdown fixes. 2014-08-14 13:57:58 +01:00
Vsevolod Stakhov
b4d2033af8 Add doc skeleton. 2014-08-14 13:54:01 +01:00
Vsevolod Stakhov
2c95b5e5a6 Add basic configuration documentation. 2014-08-14 13:48:06 +01:00
Andrew Lewis
a0fcf6237c Tweak updated config example for consistency/clarity 2014-02-07 12:32:59 +02:00
Andrew Lewis
dca39cf240 Fix documentation for RBL module - rbls {} was not referenced 2014-02-07 12:10:09 +02:00
Andrew Lewis
86086d65b2 Add documentation for RBL module 2014-01-31 21:34:28 +02:00
Vsevolod Stakhov
71a604c150 Another polish round. 2014-01-24 00:17:45 +00:00
Vsevolod Stakhov
b4760ccee2 Markdown polish. 2014-01-24 00:15:10 +00:00
Vsevolod Stakhov
10c60f03d2 Update documentation. 2014-01-24 00:12:37 +00:00