Add doc skeleton.

diff --git a/doc/markdown/configuration/composites.md b/doc/markdown/configuration/composites.md
index 2fa3ea5689b6af1cacf555727975160788accff5..fc734af2a7a827e62fb5e91bb68527d4d16e7708 100644 (file)
--- a/doc/markdown/configuration/composites.md
+++ b/doc/markdown/configuration/composites.md
@@ -1,4 +1,17 @@
-# Rspamd composite rules
+# Rspamd composite symbols
+
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction
 
 Rspamd composites are used to combine rules and create more complex rules.
 Composite rules are defined by `composite` keys. The value of this key should be

diff --git a/doc/markdown/configuration/logging.md b/doc/markdown/configuration/logging.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..b6d9584db6a440510b8c1f359a9f133ec17cdcf5 100644 (file)
--- a/doc/markdown/configuration/logging.md
+++ b/doc/markdown/configuration/logging.md
@@ -0,0 +1,39 @@
+# Rspamd logging settings
+
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction
+Rspamd has a number of logging variants. First of all there are three types of logs that are supported by rspamd: console loggging (just output log messages to console), file logging (output log messages to file) and logging via syslog. Also it is possible to filter logging to specific level:
+
+* `error` - log only critical errors
+* `warning` - log errors and warnings
+* `info` - log all non-debug messages
+* `debug` - log all including debug messages (huge amount of logging) 
+
+Also it is possible to turn on debug messages for specific ip addresses. This ability is usefull for testing. For each logging type there are special mandatory parameters: log facility for syslog (read `syslog(3)` manual page for details about facilities), log file for file logging. Also file logging may be buffered for speeding up. For reducing logging noise rspamd detects for sequential identic log messages and replace them with total number of repeats:
+
+```
+#81123(fuzzy): May 11 19:41:54 rspamd file_log_function: Last message repeated 155 times
+#81123(fuzzy): May 11 19:41:54 rspamd process_write_command: fuzzy hash was successfully added
+```
+
+## Configuration parameters
+
+Here is summary of logging parameters: 
+* `type` - Defines logging type (file, console or syslog). For some types mandatory attribute is required:
+  - `filename` - path to log file for file logging
+  - `facility` - logging facility for syslog
+* `level` - Defines loggging level (error, warning, info or debug).
+* `log_buffer` - For file and console logging defines buffer size that will be used for logging output.
+* `log_urls` - Flag that defines whether all urls in message would be logged. Useful for testing.
+* `debug_ip` - List that contains ip addresses for which debugging would be turned on.
+* `log_color` - Turn on coloring for log messages. Default: `no`.

diff --git a/doc/markdown/configuration/metrics.md b/doc/markdown/configuration/metrics.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..bba36a650a1fea368e93b69142a0f29ee41066d6 100644 (file)
--- a/doc/markdown/configuration/metrics.md
+++ b/doc/markdown/configuration/metrics.md
@@ -0,0 +1,14 @@
+# Rspamd metrics settings
+
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction

diff --git a/doc/markdown/configuration/options.md b/doc/markdown/configuration/options.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..71d622a6849b8797f60d726b6529236cbacded6f 100644 (file)
--- a/doc/markdown/configuration/options.md
+++ b/doc/markdown/configuration/options.md
@@ -0,0 +1,14 @@
+# Rspamd options settings
+
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction

diff --git a/doc/markdown/configuration/settings.md b/doc/markdown/configuration/settings.md
index 94eba112f9e326177f9eeb4e904d8fc7d2db84f9..7c177dd41f19997232b25513874a4ae603d6d75a 100644 (file)
--- a/doc/markdown/configuration/settings.md
+++ b/doc/markdown/configuration/settings.md
@@ -1,5 +1,18 @@
 # Rspamd user settings
 
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction
+
 Rspamd allows to specify custom settings according to incoming messages. Each setting define some set
 of custom metric weights, symbols or actions. An administrator can also skip spam checks for certain
 messages completely. Unlike the most of configuration options, rspamd settings can be loaded dynamically
@@ -61,4 +74,4 @@ Regexp rules are slow and should not be used intensively. All other rules are ma
 
 The picture below describes the architecture of settings matching.
 
-![Settings match procedure](settings.png "Settings match procedure")
\ No newline at end of file
+![Settings match procedure](settings.png "Settings match procedure")

diff --git a/doc/markdown/configuration/statistic.md b/doc/markdown/configuration/statistic.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..5caca9150709c9185dc4c7cee66f17cf8ea2a6e2 100644 (file)
--- a/doc/markdown/configuration/statistic.md
+++ b/doc/markdown/configuration/statistic.md
@@ -0,0 +1,14 @@
+# Rspamd statistic settings
+
+## Table of Contents
+
+* [Options](options.md)
+* [Logging](logging.md)
+* [Metrics](metrics.md)
+* [Composites](composites.md)
+* [User settings](settings.md)
+* [Statistic configuration](statistic.md)
+* [Workers](../workers/index.md)
+* [Modules](../modules/index.md)
+
+## Introduction