summaryrefslogtreecommitdiffstats
path: root/doc/modules.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/modules.html')
-rw-r--r--doc/modules.html40
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/modules.html b/doc/modules.html
new file mode 100644
index 00000000..bd702596
--- /dev/null
+++ b/doc/modules.html
@@ -0,0 +1,40 @@
+<html><head>
+<title>Writing syslog Data to MySQL</title>
+<meta name="KEYWORDS" content="syslog, mysql, syslog to mysql, howto">
+</head>
+<body>
+<h1>About rsyslog Modules</h1>
+ <P><small><i>Written by
+ <a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer
+ Gerhards</a> (2007-07-26)</i></small></P>
+<p><font color="#FF0000"><b>This document is incomplete. The module interface is
+also quite incomplete and under development. Do not currently use it!</b></font>
+You may want to visit <a href="http://rgerhards.blogspot.com/">Rainer's blog</a>
+to learn what's going on.</p>
+<h2>Overview</h2>
+<p>In theory, modules provide input and output, among other functions, in
+rsyslog. In practice, modules are only utilized for output in the current
+release. The module interface is not yet completed and a moving target. We do
+not recommend to write a module based on the current specification. If you do,
+please be prepared that future released of rsyslog will probably break your
+module. </p>
+<p>A goal of modularization is to provide an easy to use plug-in interface.
+However, this goal is not yet reached and all modules must be statically linked.</p>
+<h2>Module Security</h2>
+<p>Modules are directly loaded into rsyslog's address space. As such, any module
+is provided a big level of trust. Please note that further module interfaces
+might provide a way to load a module into an isolated address space. This,
+however, is far from being completed. So the number one rule about module
+security is to run only code that you know you can trust.</p>
+<h2>Copyright</h2>
+<p>Copyright (c) 2007
+<a href="http://www.adiscon.com/en/people/rainer-gerhards.php">Rainer Gerhards</a>
+and <a href="http://www.adiscon.com/en/">Adiscon</a>.</p>
+<p>Permission is granted to copy, distribute and/or modify this document under
+the terms of the GNU Free Documentation License, Version 1.2 or any later
+version published by the Free Software Foundation; with no Invariant Sections,
+no Front-Cover Texts, and no Back-Cover Texts. A copy of the license can be
+viewed at <a href="http://www.gnu.org/copyleft/fdl.html">
+http://www.gnu.org/copyleft/fdl.html</a>.</p>
+</body>
+</html> \ No newline at end of file