Skip to content

Commit

Permalink
Readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
driskell committed Jun 29, 2014
1 parent 398571f commit 1fd089d
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,16 @@ Otherwise, simply run make standalone as follows.

The log-courier program can then be found in the 'bin' folder.

A genkey utility can also be found in 'bin' when ZMQ support is built. This
utility will generate CurveZMQ key pair configurations for you.

*If you receive errors, try using `gmake` instead.*

### Logstash Integration

Details instructions on how to integrate with Logstash can be found on the
[Logstash Integration](docs/LogstashIntegration.md) page.

### Generating Certificates and Keys

To quickly create a self-signed SSL certificate, run `make selfsigned`. This
Expand All @@ -62,16 +70,6 @@ information to pass validation. Open spec/lib/openssl.cnf in your favourite
editor and look for `#subjectAltName = IP:1.1.1.1`, remove the pound prefix,
set the IP address, and run `make selfsigned` again.*

A genkey utility can also be found in 'bin' when ZMQ support is built. This
utility will generate CurveZMQ key pair configurations for you.

### LogStash 1.4.x Integration

The log-courier program can then be found in the 'bin' folder.

A genkey utility can also be found in the 'bin' folder when ZMQ support is
built. This utility will generate CurveZMQ key pair configurations for you.

## Command Line Options

The log-courier command accepts the following command line options.
Expand All @@ -85,6 +83,5 @@ The log-courier command accepts the following command line options.

## Documentation

* [Logstash Integration](docs/LogstashIntegration.md)
* [Configuration](docs/Configuration.md)
* [Change Log](docs/ChangeLog.md)

0 comments on commit 1fd089d

Please sign in to comment.