I created a sample page: http://www.fail2ban.org/wiki/index.php/Sandbox/Documentation_Page


On Thu, Jun 27, 2013 at 11:11 AM, Yehuda Katz <yehuda@ymkatz.net> wrote:
What I have seen some other projects do (can't remember which right now) is put most of the documentation in the code (using something like POD for Perl, maybe we could use ReStructuredText) and have a post-commit hook that writes that documentation to the wiki page, using a sub-page:
<!-- ------------------------------------------------------ -->
<!--  The text of the Documentation is on a locked subpage which is created automatically from comments in __FILE__.  --> 
<!--  Please make all changes to GitHub and this page will be updated by a post-commit hook.     --> 
<!-- ------------------------------------------------------ -->
{{docs}}
<br>
== Notes ==
<!-- ---------------------------------------------------------- -->
<!-- Add more resources here -->
<!-- ---------------------------------------------------------- -->

Thoughts?


On Thu, Jun 27, 2013 at 3:54 AM, Tom Hendrikx <tom@whyscream.net> wrote:
On 06/26/2013 03:42 PM, Sebastian Arcus wrote:
>> Or perhaps we can obsolete the wiki pages and point straight to the filter.
>
> Maybe that's not a bad idea. The reason I raised it is because the wiki
> page comes up pretty much at top of Google results when searching for
> Asterisk+fail2ban - so I guess it is likely that many people will think
> it is current information (I did so too until I dug around some more).
>
> However, one of the advantages of the wiki page is that it includes
> extra setup information. For example for Asterisk, it is necessary to
> change the date format and configure the security log in
> /etc/asterisk/logger.conf - as it isn't turned on by default - and then
> to restart the logger module in Asterisk. For the above filter, the main
> log would need to be configured to include security logging (as opposed
> to having a separate security log, which is another route some setups go
> - with separate filter/jail for the main and security logs). Unless that
> information can be included somewhere in the Github.

IMHO, the easiest way to make sure that the documentation doesn't get
out of sync with the filter definitions, is to add it to the filter
itself. Add the required/preferred Asterisk setup as comments in the
file, and simply make the wiki page say "yes we support it" and point to
the filter file on github for the gory details.

Regards,
        Tom


------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:

Build for Windows Store.

http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
Fail2ban-users mailing list
Fail2ban-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/fail2ban-users