moved FAQ to github wiki

This commit is contained in:
Matt Simerson 2013-03-26 23:37:08 -07:00
parent 58b860c0eb
commit fcc6d4d55f
3 changed files with 2 additions and 48 deletions

View File

@ -25,7 +25,6 @@ docs/advanced.pod
docs/authentication.pod docs/authentication.pod
docs/config.pod docs/config.pod
docs/development.pod docs/development.pod
docs/FAQ.pod
docs/hooks.pod docs/hooks.pod
docs/logging.pod docs/logging.pod
docs/plugins.pod docs/plugins.pod

2
README
View File

@ -12,6 +12,8 @@ web:
mailinglist: mailinglist:
qpsmtpd-subscribe@perl.org qpsmtpd-subscribe@perl.org
FAQ:
https://github.com/qpsmtpd-dev/qpsmtpd-dev/wiki/faq
=head1 DESCRIPTION =head1 DESCRIPTION

View File

@ -1,47 +0,0 @@
# best read with perldoc: perldoc FAQ.pod
=head1 FAQ
=head2 Q: Do I need to enable a logging plugin?
=head2 A: No.
When zero logging plugins are configured, logs are directed to STDERR. This
is the 'default' logging and logs are piped to multilog and stored in
log/main/current.
When more than zero logging plugins are enabled, builtin logging is disabled
and logs are sent to every logging plugin configured in config/plugins.
=head2 Q: How do I watch the logs?
=head2 A: Here's a few examples:
The default log files can be watched in real time lik this:
tail -F ~smtpd/log/main/current
To convert the tai timestamps to human readable date time:
tail -F ~smtpd/log/main/current | tai64nlocal
To exclude the dates entirely, use this command:
tail -F ~smtpd/smtpd/log/main/current | cut -d' ' -f2-3
=head2 Q: How do I get alerts when qpsmtpd has a problem?
=head2 A: Send logs with levels below LOGERROR to syslog.
This can be done by adding the following lines to config/plugins:
logging/syslog loglevel LOGERROR
logging/warn LOGINFO
The warn logging plugin replicates the builtin logging, directing log messages to STDERR. The syslog plugin directs errors to syslog where standard monitoring tools can pick them up and act on them.
With these settings, errors will still get sent to STDERR as well.
=cut