diff --git a/README.md b/README.md index 275c241..ab5cc9a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # Simple Syslog Server -Basic syslog server written in Java. All received messages are written to *stdout* or optionally forwarded to another syslog server. +All received messages are written to *stdout* and optionally forwarded to another syslog server. The syslog server is able to listen on UDP and/or TCP and parses syslog messages in either RFC5424 or RFC3164 (BSD) format. The default syslog port (514) requires you to run syslogd as root / administrator. -If you do not wish to do so, you can choose a port number (with the -p flag) above 1024. +If you do not wish to do so, you can choose a port number (with the *-p* or *--port* flag) above 1024. ## Usage Instructions @@ -13,21 +13,46 @@ If you do not wish to do so, you can choose a port number (with the -p flag) abo - Run *bin/syslogd*, use the *-h* option for help :) ```` -Usage: syslogd [-fhV] [--[no-]ansi] [--[no-]stdout] [--[no-]tcp] [--[no-]udp] - [--rfc5424] [--forward-host=] [--forward-port=] - [-p=] +Usage: syslogd [-dhV] [--[no-]ansi] [--[no-]stdout] [--[no-]tcp] [--[no-]udp] + [--rfc5424] [-f=] [-p=] Simple Syslog Server - -f, --forward Forward messages (UDP RFC-3164) [default: false]. - --forward-host= - Forward to host [default: localhost]. - --forward-port= - Forward to port [default: 1514]. - -h, --help Show this help message and exit. - --[no-]ansi Output ANSI colors [default: true]. - --[no-]stdout Output messages to stdout [default: true]. - --[no-]tcp Listen on TCP [default: true]. - --[no-]udp Listen on UDP [default: true]. - -p, --port= Listening port [default: 514]. - --rfc5424 Parse RFC-5424 messages [default: RFC-3164]. - -V, --version Print version information and exit. + -d, --debug Enable debugging [default: 'false']. + -f, --forward= Forward to UDP host[:port] (RFC-5424). + -h, --help Show this help message and exit. + --[no-]ansi Output ANSI colors [default: true]. + --[no-]stdout Output messages to stdout [default: true]. + --[no-]tcp Listen on TCP [default: true]. + --[no-]udp Listen on UDP [default: true]. + -p, --port= Listening port [default: 514]. + --rfc5424 Parse RFC-5424 messages [default: RFC-3164]. + -V, --version Print version information and exit. + ```` + +### Examples + +Listening on a non-standard syslog port: + +``` +java -jar /path/to/syslogd-x.y.z-all.jar --port 1514 +``` + +or, if installed as a *deb* or *rpm* package: + +``` +/opt/syslogd/bin/syslogd --port 1514 +``` + +Listening on the standard syslog port (requires root privileges) and forwarding messages on to another log-system on a non-standard port. + +``` +java -jar /path/to/syslogd-x.y.z-all.jar --forward remotehost:1514 +``` + +If you don't want any output locally (only forwarding), you can use the ```--no-stdout``` flag. + + +## Notes + +Syslog messages from AIX (and IBM Power Virtual I/O Servers) can be troublesome with some logging solutions. These can be received with +syslogd and optionally forwarded on to Graylog, Splunk or other logging solutions. diff --git a/doc/readme-service.md b/doc/readme-service.md index 32058d2..5994ff4 100644 --- a/doc/readme-service.md +++ b/doc/readme-service.md @@ -2,7 +2,7 @@ ## Systemd -Edit the **syslogd.service** and provide wanted options. +Edit the **syslogd.service** and configure required options. To install as a systemd service, copy the **syslogd.service** file into */etc/systemd/system/* and enable the service: