diff --git a/README.md b/README.md index 036fd55..6bdbb30 100644 --- a/README.md +++ b/README.md @@ -26,12 +26,10 @@ Based on the official images: 2. Install [Docker-compose](http://docs.docker.com/compose/install/) **version >= 1.6**. 3. Clone this repository -## Increase max_map_count on your host +## Increase `vm.max_map_count` on your host -You need to increase `max_map_count` on your Docker host. -To do this follow the recommended instructions within the elastic documentation: - -https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode +You need to increase the `vm.max_map_count` kernel setting on your Docker host. +To do this follow the recommended instructions from the Elastic documentation: [Install Elasticsearch with Docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode) ## SELinux @@ -39,8 +37,7 @@ On distributions which have SELinux enabled out-of-the-box you will need to eith For example on Redhat and CentOS, the following will apply the proper context: ```bash -.-root@centos ~ --$ chcon -R system_u:object_r:admin_home_t:s0 docker-elk/ +$ chcon -R system_u:object_r:admin_home_t:s0 docker-elk/ ``` # Usage @@ -65,9 +62,9 @@ $ nc localhost 5000 < /path/to/logfile.log And then access Kibana UI by hitting [http://localhost:5601](http://localhost:5601) with a web browser. -*NOTE*: You'll need to inject data into logstash before being able to create a logstash index in Kibana. Then all you should have to do is to hit the create button. +*NOTE*: You'll need to inject data into logstash before being able to configure a logstash index pattern in Kibana. Then all you should have to do is to hit the create button. -See: https://www.elastic.co/guide/en/kibana/current/setup.html#connect +Refer to [Connect Kibana with Elasticsearch](https://www.elastic.co/guide/en/kibana/current/connect-to-elasticsearch.html) for detailed instructions about the index pattern configuration. By default, the stack exposes the following ports: * 5000: Logstash TCP input.