|
5 | 5 | <h4 align="center">With tools like Curator, Rubban, ElastAlert for Alerting.</h4>
|
6 | 6 | <p align="center">
|
7 | 7 | <a>
|
8 |
| - <img src="https://img.shields.io/badge/Elastic%20Stack-7.9.2-blue?style=flat&logo=elasticsearch" alt="Elastic Stack Version 7^^"> |
| 8 | + <img src="https://img.shields.io/badge/Elastic%20Stack-7.9.3-blue?style=flat&logo=elasticsearch" alt="Elastic Stack Version 7^^"> |
9 | 9 | </a>
|
10 | 10 | <a>
|
11 | 11 | <img src="https://img.shields.io/github/v/tag/sherifabdlnaby/elastdocker?label=release&sort=semver">
|
|
25 | 25 | </p>
|
26 | 26 |
|
27 | 27 | # Introduction
|
28 |
| -Elastic Stack (AKA **ELK**) Docker Composition, preconfigured with **Security**, **Monitoring**, and Tools Up with a Single Command. |
| 28 | +Elastic Stack (AKA **ELK**) Docker Composition, preconfigured with **Security**, **Monitoring**, and Tools; Up with a Single Command. |
29 | 29 |
|
30 | 30 | Based on [Official Elastic Docker Images](https://www.docker.elastic.co/)
|
31 | 31 |
|
32 |
| -Stack Version: [7.9.2](https://www.elastic.co/blog/elastic-stack-7-9-2-released). |
| 32 | +Stack Version: [7.9.3](https://www.elastic.co/blog/elastic-stack-7-9-3-released) |
33 | 33 | > You can change Elastic Stack version by setting `ELK_VERSION` in `.env` file and rebuild your images. Any version >= 7.0.0 is compatible with this template.
|
34 | 34 |
|
35 | 35 | ### Main Features 📜
|
@@ -94,28 +94,24 @@ Elastdocker differs from `deviantony/docker-elk` in the following points.
|
94 | 94 | ```bash
|
95 | 95 | git clone https://github.com/sherifabdlnaby/elastdocker.git
|
96 | 96 | ```
|
97 |
| - or: |
98 |
| - <a href="https://github.com/sherifabdlnaby/elastdocker/generate"><img src="https://user-images.githubusercontent.com/16992394/92532187-08e81180-f230-11ea-96c9-07e9331411bc.png" alt="create repository from template"></a> |
99 |
| - |
100 |
| -2. Initialize Elasticsearch Keystore and SSL Certificates |
101 |
| - ```shell |
| 97 | +2. Initialize Elasticsearch Keystore and TLS Self-Signed Certificates |
| 98 | + ```bash |
102 | 99 | $ make setup
|
103 | 100 | ```
|
| 101 | + > **For Linux's docker hosts only**. By default virtual memory [is not enough](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html) so run the next command as root `sysctl -w vm.max_map_count=262144` |
104 | 102 | 3. Start Elastic Stack
|
105 |
| - ```shell |
106 |
| - $ make elk |
107 |
| - ---- OR ---- |
108 |
| - $ docker-compose up -d |
| 103 | + ```bash |
| 104 | + $ make elk <OR> docker-compose up -d |
109 | 105 | ```
|
110 |
| -4. Visit Kibana at [https://localhost:5601](https://localhost:5601) |
| 106 | +4. Visit Kibana at [https://localhost:5601](https://localhost:5601) or `https://<your_public_ip>:5601` |
111 | 107 |
|
112 |
| - Notice that Kibana is configured to use HTTPS, so you'll need to write `https://` before `localhost:5601` in the browser. |
| 108 | + Default Username: `elastic`, Password: `changeme` |
113 | 109 |
|
114 |
| - Username: `elastic` Password: `changeme` |
| 110 | + > Notice that Kibana is configured to use HTTPS, so you'll need to write `https://` before `localhost:5601` in the browser. |
115 | 111 |
|
116 | 112 | > Modify `.env` file for your needs, most importantly `ELASTIC_PASSWORD` that setup your superuser `elastic`'s password, `ELASTICSEARCH_HEAP` & `LOGSTASH_HEAP` for Elasticsearch & Logstash Heap Size.
|
117 | 113 |
|
118 |
| -Whatever your Host (e.g AWS EC2, Azure, On-premise server), once you expose your host to the network ELK component will be accessible on their respective ports. |
| 114 | +Whatever your Host (e.g AWS EC2, Azure, DigitalOcean, or on-premise server), once you expose your host to the network, ELK component will be accessible on their respective ports. |
119 | 115 |
|
120 | 116 | ### Docker Swarm Support
|
121 | 117 |
|
@@ -169,7 +165,7 @@ $ make prune
|
169 | 165 |
|
170 | 166 | * Some Configuration are parameterized in the `.env` file.
|
171 | 167 | * `ELASTIC_PASSWORD`, user `elastic`'s password (default: `changeme` _pls_).
|
172 |
| - * `ELK_VERSION` Elastic Stack Version (default: `7.9.2`) |
| 168 | + * `ELK_VERSION` Elastic Stack Version (default: `7.9.3`) |
173 | 169 | * `ELASTICSEARCH_HEAP`, how much Elasticsearch allocate from memory (default: 1GB -good for development only-)
|
174 | 170 | * `LOGSTASH_HEAP`, how much Logstash allocate from memory.
|
175 | 171 | * Other configurations which their such as cluster name, and node name, etc.
|
|
0 commit comments