{"owner":"deviantony","repo":"docker-elk","hasSkills":true,"totalSkillsCount":6,"totalTokensCount":2081,"categories":["plugin-manifest"],"hasMcp":false,"mcpConfig":null,"found":["extensions/fleet/README.md","extensions/metricbeat/README.md","extensions/heartbeat/README.md","extensions/curator/README.md","extensions/README.md","extensions/filebeat/README.md"],"skills":{"extensions/fleet/README.md":"# Fleet Server\n\n> [!WARNING]\n> This extension currently exists for preview purposes and should be considered **EXPERIMENTAL**. Expect regular changes\n> to the default Fleet settings, both in the Elastic Agent and Kibana.\n>\n> See [Known Issues](#known-issues) for a list of issues that need to be addressed before this extension can be\n> considered functional.\n\nFleet provides central management capabilities for [Elastic Agents][fleet-doc] via an API and web UI served by Kibana,\nwith Elasticsearch acting as the communication layer.\nFleet Server is the central component which allows connecting Elastic Agents to the Fleet.\n\n## Requirements\n\nThe Fleet Server exposes the TCP port `8220` for Agent to Server communications.\n\n## Usage\n\nTo include Fleet Server in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `fleet-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/fleet/fleet-compose.yml up\n```\n\n## Configuring Fleet Server\n\nFleet Server — like any Elastic Agent — is configured via [Agent Policies][fleet-pol] which can be either managed\nthrough the Fleet management UI in Kibana, or statically pre-configured inside the Kibana configuration file.\n\nTo ease the enrollment of Fleet Server in this extension, docker-elk comes with a pre-configured Agent Policy for Fleet\nServer defined inside [`kibana/config/kibana.yml`][config-kbn].\n\nPlease refer to the following documentation page for more details about configuring Fleet Server through the Fleet\nmanagement UI: [Fleet UI Settings][fleet-cfg].\n\n## Known Issues\n\n- The Elastic Agent auto-enrolls using the `elastic` super-user. With this approach, you do not need to generate a\n service token — either using the Fleet management UI or [CLI utility][es-svc-token] — prior to starting this\n extension. However convenient that is, this approach _does not follow security best practices_, and we recommend\n generating a service token for Fleet Server instead.\n\n## See also\n\n[Fleet and Elastic Agent Guide][fleet-doc]\n\n## Screenshots\n\n![fleet-agents](https://user-images.githubusercontent.com/3299086/202701399-27518fe4-17b7-49d1-aefb-868dffeaa68a.png\n\"Fleet Agents\")\n![elastic-agent-dashboard](https://user-images.githubusercontent.com/3299086/202701404-958f8d80-a7a0-4044-bbf9-bf73f3bdd17a.png\n\"Elastic Agent Dashboard\")\n\n[fleet-doc]: https://www.elastic.co/docs/reference/fleet\n[fleet-pol]: https://www.elastic.co/docs/reference/fleet/agent-policy\n[fleet-cfg]: https://www.elastic.co/docs/reference/fleet/fleet-settings\n\n[config-kbn]: ../../kibana/config/kibana.yml\n\n[es-svc-token]: https://www.elastic.co/docs/reference/elasticsearch/command-line-tools/service-tokens-command\n","extensions/metricbeat/README.md":"# Metricbeat\n\nMetricbeat is a lightweight shipper that you can install on your servers to periodically collect metrics from the\noperating system and from services running on the server. Metricbeat takes the metrics and statistics that it collects\nand ships them to the output that you specify, such as Elasticsearch or Logstash.\n\n## Usage\n\n**This extension requires the `metricbeat_internal`, `monitoring_internal` and `beats_system` users to be created and\ninitialized with a password.** In case you haven't done that during the initial startup of the stack, please refer to\n[How to re-execute the setup][setup] to run the setup container again and initialize these users.\n\nTo include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `metricbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up\n```\n\n## Configuring Metricbeat\n\nThe Metricbeat configuration is stored in [`config/metricbeat.yml`](./config/metricbeat.yml). You can modify this file\nwith the help of the [Configuration reference][metricbeat-config].\n\nAny change to the Metricbeat configuration requires a restart of the Metricbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml restart metricbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Metricbeat inside a\nDocker container: [Run Metricbeat on Docker][metricbeat-docker].\n\n## See also\n\n[Metricbeat documentation][metricbeat-doc]\n\n## Screenshots\n\n![stack-monitoring](https://user-images.githubusercontent.com/3299086/202710574-32a3d419-86ea-4334-b6f7-62d7826df18d.png\n\"Stack Monitoring\")\n![host-dashboard](https://user-images.githubusercontent.com/3299086/202710594-0deccf40-3a9a-4e63-8411-2e0d9cc6ad3a.png\n\"Host Overview Dashboard\")\n\n[metricbeat-config]: https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-reference-yml\n[metricbeat-docker]: https://www.elastic.co/docs/reference/beats/metricbeat/running-on-docker\n[metricbeat-doc]: https://www.elastic.co/docs/reference/beats/metricbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","extensions/heartbeat/README.md":"# Heartbeat\n\nHeartbeat is a lightweight daemon that periodically checks the status of your services and determines whether they are\navailable.\n\n## Usage\n\n**This extension requires the `heartbeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Heartbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `heartbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml up\n```\n\n## Configuring Heartbeat\n\nThe Heartbeat configuration is stored in [`config/heartbeat.yml`](./config/heartbeat.yml). You can modify this file\nwith the help of the [Configuration reference][heartbeat-config].\n\nAny change to the Heartbeat configuration requires a restart of the Heartbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml restart heartbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Heartbeat inside a\nDocker container: [Run Heartbeat on Docker][heartbeat-docker].\n\n## See also\n\n[Heartbeat documentation][heartbeat-doc]\n\n[heartbeat-config]: https://www.elastic.co/docs/reference/beats/heartbeat/heartbeat-reference-yml\n[heartbeat-docker]: https://www.elastic.co/docs/reference/beats/heartbeat/running-on-docker\n[heartbeat-doc]: https://www.elastic.co/docs/reference/beats/heartbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","extensions/curator/README.md":"# Curator\n\nElasticsearch Curator helps you curate or manage your indices.\n\n## Usage\n\nIf you want to include the Curator extension, run Docker Compose from the root of the repository with an additional\ncommand line argument referencing the `curator-compose.yml` file:\n\n```bash\n$ docker compose -f docker-compose.yml -f extensions/curator/curator-compose.yml up\n```\n\nThis sample setup demonstrates how to run `curator` every minute using `cron`.\n\nAll configuration files are available in the `config/` directory.\n\n## Documentation\n\n[Curator Reference](https://www.elastic.co/docs/reference/elasticsearch/curator)\n","extensions/README.md":"# Extensions\n\nThird-party extensions that enable extra integrations with the Elastic stack.\n","extensions/filebeat/README.md":"# Filebeat\n\nFilebeat is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers,\nFilebeat monitors the log files or locations that you specify, collects log events, and forwards them either to\nElasticsearch or Logstash for indexing.\n\n## Usage\n\n**This extension requires the `filebeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Filebeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `filebeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml up\n```\n\n## Configuring Filebeat\n\nThe Filebeat configuration is stored in [`config/filebeat.yml`](./config/filebeat.yml). You can modify this file with\nthe help of the [Configuration reference][filebeat-config].\n\nAny change to the Filebeat configuration requires a restart of the Filebeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml restart filebeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Filebeat inside a Docker\ncontainer: [Run Filebeat on Docker][filebeat-docker].\n\n## See also\n\n[Filebeat documentation][filebeat-doc]\n\n[filebeat-config]: https://www.elastic.co/docs/reference/beats/filebeat/filebeat-reference-yml\n[filebeat-docker]: https://www.elastic.co/docs/reference/beats/filebeat/running-on-docker\n[filebeat-doc]: https://www.elastic.co/docs/reference/beats/filebeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n"},"files":{"extensions/fleet/README.md":"# Fleet Server\n\n> [!WARNING]\n> This extension currently exists for preview purposes and should be considered **EXPERIMENTAL**. Expect regular changes\n> to the default Fleet settings, both in the Elastic Agent and Kibana.\n>\n> See [Known Issues](#known-issues) for a list of issues that need to be addressed before this extension can be\n> considered functional.\n\nFleet provides central management capabilities for [Elastic Agents][fleet-doc] via an API and web UI served by Kibana,\nwith Elasticsearch acting as the communication layer.\nFleet Server is the central component which allows connecting Elastic Agents to the Fleet.\n\n## Requirements\n\nThe Fleet Server exposes the TCP port `8220` for Agent to Server communications.\n\n## Usage\n\nTo include Fleet Server in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `fleet-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/fleet/fleet-compose.yml up\n```\n\n## Configuring Fleet Server\n\nFleet Server — like any Elastic Agent — is configured via [Agent Policies][fleet-pol] which can be either managed\nthrough the Fleet management UI in Kibana, or statically pre-configured inside the Kibana configuration file.\n\nTo ease the enrollment of Fleet Server in this extension, docker-elk comes with a pre-configured Agent Policy for Fleet\nServer defined inside [`kibana/config/kibana.yml`][config-kbn].\n\nPlease refer to the following documentation page for more details about configuring Fleet Server through the Fleet\nmanagement UI: [Fleet UI Settings][fleet-cfg].\n\n## Known Issues\n\n- The Elastic Agent auto-enrolls using the `elastic` super-user. With this approach, you do not need to generate a\n service token — either using the Fleet management UI or [CLI utility][es-svc-token] — prior to starting this\n extension. However convenient that is, this approach _does not follow security best practices_, and we recommend\n generating a service token for Fleet Server instead.\n\n## See also\n\n[Fleet and Elastic Agent Guide][fleet-doc]\n\n## Screenshots\n\n![fleet-agents](https://user-images.githubusercontent.com/3299086/202701399-27518fe4-17b7-49d1-aefb-868dffeaa68a.png\n\"Fleet Agents\")\n![elastic-agent-dashboard](https://user-images.githubusercontent.com/3299086/202701404-958f8d80-a7a0-4044-bbf9-bf73f3bdd17a.png\n\"Elastic Agent Dashboard\")\n\n[fleet-doc]: https://www.elastic.co/docs/reference/fleet\n[fleet-pol]: https://www.elastic.co/docs/reference/fleet/agent-policy\n[fleet-cfg]: https://www.elastic.co/docs/reference/fleet/fleet-settings\n\n[config-kbn]: ../../kibana/config/kibana.yml\n\n[es-svc-token]: https://www.elastic.co/docs/reference/elasticsearch/command-line-tools/service-tokens-command\n","extensions/metricbeat/README.md":"# Metricbeat\n\nMetricbeat is a lightweight shipper that you can install on your servers to periodically collect metrics from the\noperating system and from services running on the server. Metricbeat takes the metrics and statistics that it collects\nand ships them to the output that you specify, such as Elasticsearch or Logstash.\n\n## Usage\n\n**This extension requires the `metricbeat_internal`, `monitoring_internal` and `beats_system` users to be created and\ninitialized with a password.** In case you haven't done that during the initial startup of the stack, please refer to\n[How to re-execute the setup][setup] to run the setup container again and initialize these users.\n\nTo include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `metricbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up\n```\n\n## Configuring Metricbeat\n\nThe Metricbeat configuration is stored in [`config/metricbeat.yml`](./config/metricbeat.yml). You can modify this file\nwith the help of the [Configuration reference][metricbeat-config].\n\nAny change to the Metricbeat configuration requires a restart of the Metricbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml restart metricbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Metricbeat inside a\nDocker container: [Run Metricbeat on Docker][metricbeat-docker].\n\n## See also\n\n[Metricbeat documentation][metricbeat-doc]\n\n## Screenshots\n\n![stack-monitoring](https://user-images.githubusercontent.com/3299086/202710574-32a3d419-86ea-4334-b6f7-62d7826df18d.png\n\"Stack Monitoring\")\n![host-dashboard](https://user-images.githubusercontent.com/3299086/202710594-0deccf40-3a9a-4e63-8411-2e0d9cc6ad3a.png\n\"Host Overview Dashboard\")\n\n[metricbeat-config]: https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-reference-yml\n[metricbeat-docker]: https://www.elastic.co/docs/reference/beats/metricbeat/running-on-docker\n[metricbeat-doc]: https://www.elastic.co/docs/reference/beats/metricbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","extensions/heartbeat/README.md":"# Heartbeat\n\nHeartbeat is a lightweight daemon that periodically checks the status of your services and determines whether they are\navailable.\n\n## Usage\n\n**This extension requires the `heartbeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Heartbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `heartbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml up\n```\n\n## Configuring Heartbeat\n\nThe Heartbeat configuration is stored in [`config/heartbeat.yml`](./config/heartbeat.yml). You can modify this file\nwith the help of the [Configuration reference][heartbeat-config].\n\nAny change to the Heartbeat configuration requires a restart of the Heartbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml restart heartbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Heartbeat inside a\nDocker container: [Run Heartbeat on Docker][heartbeat-docker].\n\n## See also\n\n[Heartbeat documentation][heartbeat-doc]\n\n[heartbeat-config]: https://www.elastic.co/docs/reference/beats/heartbeat/heartbeat-reference-yml\n[heartbeat-docker]: https://www.elastic.co/docs/reference/beats/heartbeat/running-on-docker\n[heartbeat-doc]: https://www.elastic.co/docs/reference/beats/heartbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","extensions/curator/README.md":"# Curator\n\nElasticsearch Curator helps you curate or manage your indices.\n\n## Usage\n\nIf you want to include the Curator extension, run Docker Compose from the root of the repository with an additional\ncommand line argument referencing the `curator-compose.yml` file:\n\n```bash\n$ docker compose -f docker-compose.yml -f extensions/curator/curator-compose.yml up\n```\n\nThis sample setup demonstrates how to run `curator` every minute using `cron`.\n\nAll configuration files are available in the `config/` directory.\n\n## Documentation\n\n[Curator Reference](https://www.elastic.co/docs/reference/elasticsearch/curator)\n","extensions/README.md":"# Extensions\n\nThird-party extensions that enable extra integrations with the Elastic stack.\n","extensions/filebeat/README.md":"# Filebeat\n\nFilebeat is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers,\nFilebeat monitors the log files or locations that you specify, collects log events, and forwards them either to\nElasticsearch or Logstash for indexing.\n\n## Usage\n\n**This extension requires the `filebeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Filebeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `filebeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml up\n```\n\n## Configuring Filebeat\n\nThe Filebeat configuration is stored in [`config/filebeat.yml`](./config/filebeat.yml). You can modify this file with\nthe help of the [Configuration reference][filebeat-config].\n\nAny change to the Filebeat configuration requires a restart of the Filebeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml restart filebeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Filebeat inside a Docker\ncontainer: [Run Filebeat on Docker][filebeat-docker].\n\n## See also\n\n[Filebeat documentation][filebeat-doc]\n\n[filebeat-config]: https://www.elastic.co/docs/reference/beats/filebeat/filebeat-reference-yml\n[filebeat-docker]: https://www.elastic.co/docs/reference/beats/filebeat/running-on-docker\n[filebeat-doc]: https://www.elastic.co/docs/reference/beats/filebeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n"},"items":[{"name":"README.md","path":"extensions/curator/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/curator/README.md","title":"curator Documentation","category":"plugin-manifest","format":"markdown","content":"# Curator\n\nElasticsearch Curator helps you curate or manage your indices.\n\n## Usage\n\nIf you want to include the Curator extension, run Docker Compose from the root of the repository with an additional\ncommand line argument referencing the `curator-compose.yml` file:\n\n```bash\n$ docker compose -f docker-compose.yml -f extensions/curator/curator-compose.yml up\n```\n\nThis sample setup demonstrates how to run `curator` every minute using `cron`.\n\nAll configuration files are available in the `config/` directory.\n\n## Documentation\n\n[Curator Reference](https://www.elastic.co/docs/reference/elasticsearch/curator)\n","isInternal":false,"tokens":136,"sizeBytes":611},{"name":"README.md","path":"extensions/filebeat/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/filebeat/README.md","title":"filebeat Documentation","category":"plugin-manifest","format":"markdown","content":"# Filebeat\n\nFilebeat is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers,\nFilebeat monitors the log files or locations that you specify, collects log events, and forwards them either to\nElasticsearch or Logstash for indexing.\n\n## Usage\n\n**This extension requires the `filebeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Filebeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `filebeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml up\n```\n\n## Configuring Filebeat\n\nThe Filebeat configuration is stored in [`config/filebeat.yml`](./config/filebeat.yml). You can modify this file with\nthe help of the [Configuration reference][filebeat-config].\n\nAny change to the Filebeat configuration requires a restart of the Filebeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml restart filebeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Filebeat inside a Docker\ncontainer: [Run Filebeat on Docker][filebeat-docker].\n\n## See also\n\n[Filebeat documentation][filebeat-doc]\n\n[filebeat-config]: https://www.elastic.co/docs/reference/beats/filebeat/filebeat-reference-yml\n[filebeat-docker]: https://www.elastic.co/docs/reference/beats/filebeat/running-on-docker\n[filebeat-doc]: https://www.elastic.co/docs/reference/beats/filebeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","isInternal":false,"tokens":399,"sizeBytes":1812},{"name":"README.md","path":"extensions/fleet/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/fleet/README.md","title":"fleet Documentation","category":"plugin-manifest","format":"markdown","content":"# Fleet Server\n\n> [!WARNING]\n> This extension currently exists for preview purposes and should be considered **EXPERIMENTAL**. Expect regular changes\n> to the default Fleet settings, both in the Elastic Agent and Kibana.\n>\n> See [Known Issues](#known-issues) for a list of issues that need to be addressed before this extension can be\n> considered functional.\n\nFleet provides central management capabilities for [Elastic Agents][fleet-doc] via an API and web UI served by Kibana,\nwith Elasticsearch acting as the communication layer.\nFleet Server is the central component which allows connecting Elastic Agents to the Fleet.\n\n## Requirements\n\nThe Fleet Server exposes the TCP port `8220` for Agent to Server communications.\n\n## Usage\n\nTo include Fleet Server in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `fleet-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/fleet/fleet-compose.yml up\n```\n\n## Configuring Fleet Server\n\nFleet Server — like any Elastic Agent — is configured via [Agent Policies][fleet-pol] which can be either managed\nthrough the Fleet management UI in Kibana, or statically pre-configured inside the Kibana configuration file.\n\nTo ease the enrollment of Fleet Server in this extension, docker-elk comes with a pre-configured Agent Policy for Fleet\nServer defined inside [`kibana/config/kibana.yml`][config-kbn].\n\nPlease refer to the following documentation page for more details about configuring Fleet Server through the Fleet\nmanagement UI: [Fleet UI Settings][fleet-cfg].\n\n## Known Issues\n\n- The Elastic Agent auto-enrolls using the `elastic` super-user. With this approach, you do not need to generate a\n service token — either using the Fleet management UI or [CLI utility][es-svc-token] — prior to starting this\n extension. However convenient that is, this approach _does not follow security best practices_, and we recommend\n generating a service token for Fleet Server instead.\n\n## See also\n\n[Fleet and Elastic Agent Guide][fleet-doc]\n\n## Screenshots\n\n![fleet-agents](https://user-images.githubusercontent.com/3299086/202701399-27518fe4-17b7-49d1-aefb-868dffeaa68a.png\n\"Fleet Agents\")\n![elastic-agent-dashboard](https://user-images.githubusercontent.com/3299086/202701404-958f8d80-a7a0-4044-bbf9-bf73f3bdd17a.png\n\"Elastic Agent Dashboard\")\n\n[fleet-doc]: https://www.elastic.co/docs/reference/fleet\n[fleet-pol]: https://www.elastic.co/docs/reference/fleet/agent-policy\n[fleet-cfg]: https://www.elastic.co/docs/reference/fleet/fleet-settings\n\n[config-kbn]: ../../kibana/config/kibana.yml\n\n[es-svc-token]: https://www.elastic.co/docs/reference/elasticsearch/command-line-tools/service-tokens-command\n","isInternal":false,"tokens":637,"sizeBytes":2746},{"name":"README.md","path":"extensions/heartbeat/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/heartbeat/README.md","title":"heartbeat Documentation","category":"plugin-manifest","format":"markdown","content":"# Heartbeat\n\nHeartbeat is a lightweight daemon that periodically checks the status of your services and determines whether they are\navailable.\n\n## Usage\n\n**This extension requires the `heartbeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Heartbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `heartbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml up\n```\n\n## Configuring Heartbeat\n\nThe Heartbeat configuration is stored in [`config/heartbeat.yml`](./config/heartbeat.yml). You can modify this file\nwith the help of the [Configuration reference][heartbeat-config].\n\nAny change to the Heartbeat configuration requires a restart of the Heartbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml restart heartbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Heartbeat inside a\nDocker container: [Run Heartbeat on Docker][heartbeat-docker].\n\n## See also\n\n[Heartbeat documentation][heartbeat-doc]\n\n[heartbeat-config]: https://www.elastic.co/docs/reference/beats/heartbeat/heartbeat-reference-yml\n[heartbeat-docker]: https://www.elastic.co/docs/reference/beats/heartbeat/running-on-docker\n[heartbeat-doc]: https://www.elastic.co/docs/reference/beats/heartbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","isInternal":false,"tokens":362,"sizeBytes":1703},{"name":"README.md","path":"extensions/metricbeat/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/metricbeat/README.md","title":"metricbeat Documentation","category":"plugin-manifest","format":"markdown","content":"# Metricbeat\n\nMetricbeat is a lightweight shipper that you can install on your servers to periodically collect metrics from the\noperating system and from services running on the server. Metricbeat takes the metrics and statistics that it collects\nand ships them to the output that you specify, such as Elasticsearch or Logstash.\n\n## Usage\n\n**This extension requires the `metricbeat_internal`, `monitoring_internal` and `beats_system` users to be created and\ninitialized with a password.** In case you haven't done that during the initial startup of the stack, please refer to\n[How to re-execute the setup][setup] to run the setup container again and initialize these users.\n\nTo include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `metricbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up\n```\n\n## Configuring Metricbeat\n\nThe Metricbeat configuration is stored in [`config/metricbeat.yml`](./config/metricbeat.yml). You can modify this file\nwith the help of the [Configuration reference][metricbeat-config].\n\nAny change to the Metricbeat configuration requires a restart of the Metricbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml restart metricbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Metricbeat inside a\nDocker container: [Run Metricbeat on Docker][metricbeat-docker].\n\n## See also\n\n[Metricbeat documentation][metricbeat-doc]\n\n## Screenshots\n\n![stack-monitoring](https://user-images.githubusercontent.com/3299086/202710574-32a3d419-86ea-4334-b6f7-62d7826df18d.png\n\"Stack Monitoring\")\n![host-dashboard](https://user-images.githubusercontent.com/3299086/202710594-0deccf40-3a9a-4e63-8411-2e0d9cc6ad3a.png\n\"Host Overview Dashboard\")\n\n[metricbeat-config]: https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-reference-yml\n[metricbeat-docker]: https://www.elastic.co/docs/reference/beats/metricbeat/running-on-docker\n[metricbeat-doc]: https://www.elastic.co/docs/reference/beats/metricbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n","isInternal":false,"tokens":531,"sizeBytes":2243},{"name":"README.md","path":"extensions/README.md","rawUrl":"https://raw.githubusercontent.com/deviantony/docker-elk/HEAD/extensions/README.md","title":"extensions Documentation","category":"plugin-manifest","format":"markdown","content":"# Extensions\n\nThird-party extensions that enable extra integrations with the Elastic stack.\n","isInternal":false,"tokens":16,"sizeBytes":92}],"systemPromptSnippet":"\n\n# Curator\n\nElasticsearch Curator helps you curate or manage your indices.\n\n## Usage\n\nIf you want to include the Curator extension, run Docker Compose from the root of the repository with an additional\ncommand line argument referencing the `curator-compose.yml` file:\n\n```bash\n$ docker compose -f docker-compose.yml -f extensions/curator/curator-compose.yml up\n```\n\nThis sample setup demonstrates how to run `curator` every minute using `cron`.\n\nAll configuration files are available in the `config/` directory.\n\n## Documentation\n\n[Curator Reference](https://www.elastic.co/docs/reference/elasticsearch/curator)\n\n\n# Filebeat\n\nFilebeat is a lightweight shipper for forwarding and centralizing log data. Installed as an agent on your servers,\nFilebeat monitors the log files or locations that you specify, collects log events, and forwards them either to\nElasticsearch or Logstash for indexing.\n\n## Usage\n\n**This extension requires the `filebeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Filebeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `filebeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml up\n```\n\n## Configuring Filebeat\n\nThe Filebeat configuration is stored in [`config/filebeat.yml`](./config/filebeat.yml). You can modify this file with\nthe help of the [Configuration reference][filebeat-config].\n\nAny change to the Filebeat configuration requires a restart of the Filebeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/filebeat/filebeat-compose.yml restart filebeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Filebeat inside a Docker\ncontainer: [Run Filebeat on Docker][filebeat-docker].\n\n## See also\n\n[Filebeat documentation][filebeat-doc]\n\n[filebeat-config]: https://www.elastic.co/docs/reference/beats/filebeat/filebeat-reference-yml\n[filebeat-docker]: https://www.elastic.co/docs/reference/beats/filebeat/running-on-docker\n[filebeat-doc]: https://www.elastic.co/docs/reference/beats/filebeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n\n\n# Fleet Server\n\n> [!WARNING]\n> This extension currently exists for preview purposes and should be considered **EXPERIMENTAL**. Expect regular changes\n> to the default Fleet settings, both in the Elastic Agent and Kibana.\n>\n> See [Known Issues](#known-issues) for a list of issues that need to be addressed before this extension can be\n> considered functional.\n\nFleet provides central management capabilities for [Elastic Agents][fleet-doc] via an API and web UI served by Kibana,\nwith Elasticsearch acting as the communication layer.\nFleet Server is the central component which allows connecting Elastic Agents to the Fleet.\n\n## Requirements\n\nThe Fleet Server exposes the TCP port `8220` for Agent to Server communications.\n\n## Usage\n\nTo include Fleet Server in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `fleet-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/fleet/fleet-compose.yml up\n```\n\n## Configuring Fleet Server\n\nFleet Server — like any Elastic Agent — is configured via [Agent Policies][fleet-pol] which can be either managed\nthrough the Fleet management UI in Kibana, or statically pre-configured inside the Kibana configuration file.\n\nTo ease the enrollment of Fleet Server in this extension, docker-elk comes with a pre-configured Agent Policy for Fleet\nServer defined inside [`kibana/config/kibana.yml`][config-kbn].\n\nPlease refer to the following documentation page for more details about configuring Fleet Server through the Fleet\nmanagement UI: [Fleet UI Settings][fleet-cfg].\n\n## Known Issues\n\n- The Elastic Agent auto-enrolls using the `elastic` super-user. With this approach, you do not need to generate a\n service token — either using the Fleet management UI or [CLI utility][es-svc-token] — prior to starting this\n extension. However convenient that is, this approach _does not follow security best practices_, and we recommend\n generating a service token for Fleet Server instead.\n\n## See also\n\n[Fleet and Elastic Agent Guide][fleet-doc]\n\n## Screenshots\n\n![fleet-agents](https://user-images.githubusercontent.com/3299086/202701399-27518fe4-17b7-49d1-aefb-868dffeaa68a.png\n\"Fleet Agents\")\n![elastic-agent-dashboard](https://user-images.githubusercontent.com/3299086/202701404-958f8d80-a7a0-4044-bbf9-bf73f3bdd17a.png\n\"Elastic Agent Dashboard\")\n\n[fleet-doc]: https://www.elastic.co/docs/reference/fleet\n[fleet-pol]: https://www.elastic.co/docs/reference/fleet/agent-policy\n[fleet-cfg]: https://www.elastic.co/docs/reference/fleet/fleet-settings\n\n[config-kbn]: ../../kibana/config/kibana.yml\n\n[es-svc-token]: https://www.elastic.co/docs/reference/elasticsearch/command-line-tools/service-tokens-command\n\n\n# Heartbeat\n\nHeartbeat is a lightweight daemon that periodically checks the status of your services and determines whether they are\navailable.\n\n## Usage\n\n**This extension requires the `heartbeat_internal` and `beats_system` users to be created and initialized with a\npassword.** In case you haven't done that during the initial startup of the stack, please refer to [How to re-execute\nthe setup][setup] to run the setup container again and initialize these users.\n\nTo include Heartbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `heartbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml up\n```\n\n## Configuring Heartbeat\n\nThe Heartbeat configuration is stored in [`config/heartbeat.yml`](./config/heartbeat.yml). You can modify this file\nwith the help of the [Configuration reference][heartbeat-config].\n\nAny change to the Heartbeat configuration requires a restart of the Heartbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/heartbeat/heartbeat-compose.yml restart heartbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Heartbeat inside a\nDocker container: [Run Heartbeat on Docker][heartbeat-docker].\n\n## See also\n\n[Heartbeat documentation][heartbeat-doc]\n\n[heartbeat-config]: https://www.elastic.co/docs/reference/beats/heartbeat/heartbeat-reference-yml\n[heartbeat-docker]: https://www.elastic.co/docs/reference/beats/heartbeat/running-on-docker\n[heartbeat-doc]: https://www.elastic.co/docs/reference/beats/heartbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n\n\n# Metricbeat\n\nMetricbeat is a lightweight shipper that you can install on your servers to periodically collect metrics from the\noperating system and from services running on the server. Metricbeat takes the metrics and statistics that it collects\nand ships them to the output that you specify, such as Elasticsearch or Logstash.\n\n## Usage\n\n**This extension requires the `metricbeat_internal`, `monitoring_internal` and `beats_system` users to be created and\ninitialized with a password.** In case you haven't done that during the initial startup of the stack, please refer to\n[How to re-execute the setup][setup] to run the setup container again and initialize these users.\n\nTo include Metricbeat in the stack, run Docker Compose from the root of the repository with an additional command line\nargument referencing the `metricbeat-compose.yml` file:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml up\n```\n\n## Configuring Metricbeat\n\nThe Metricbeat configuration is stored in [`config/metricbeat.yml`](./config/metricbeat.yml). You can modify this file\nwith the help of the [Configuration reference][metricbeat-config].\n\nAny change to the Metricbeat configuration requires a restart of the Metricbeat container:\n\n```console\n$ docker compose -f docker-compose.yml -f extensions/metricbeat/metricbeat-compose.yml restart metricbeat\n```\n\nPlease refer to the following documentation page for more details about how to configure Metricbeat inside a\nDocker container: [Run Metricbeat on Docker][metricbeat-docker].\n\n## See also\n\n[Metricbeat documentation][metricbeat-doc]\n\n## Screenshots\n\n![stack-monitoring](https://user-images.githubusercontent.com/3299086/202710574-32a3d419-86ea-4334-b6f7-62d7826df18d.png\n\"Stack Monitoring\")\n![host-dashboard](https://user-images.githubusercontent.com/3299086/202710594-0deccf40-3a9a-4e63-8411-2e0d9cc6ad3a.png\n\"Host Overview Dashboard\")\n\n[metricbeat-config]: https://www.elastic.co/docs/reference/beats/metricbeat/metricbeat-reference-yml\n[metricbeat-docker]: https://www.elastic.co/docs/reference/beats/metricbeat/running-on-docker\n[metricbeat-doc]: https://www.elastic.co/docs/reference/beats/metricbeat\n\n[setup]: ../../README.md#how-to-re-execute-the-setup\n\n\n# Extensions\n\nThird-party extensions that enable extra integrations with the Elastic stack.\n"}