--- title: Air gapped install description: Some components of the Elastic Stack require additional configuration and local dependencies in order to deploy in environments without internet access... url: https://www.elastic.co/elastic/docs-builder/docs/3028/deploy-manage/deploy/self-managed/air-gapped-install products: - Elastic Cloud Enterprise - Elastic Stack applies_to: - Self-managed Elastic deployments: Generally available --- # Air gapped install Some components of the Elastic Stack require additional configuration and local dependencies in order to deploy in environments without internet access. This guide gives an overview of this setup scenario and connects you to existing documentation for individual parts of the stack. Refer to the section for each Elastic component for air-gapped installation configuration and dependencies in a self-managed Linux environment. ## Elasticsearch Air-gapped install of Elasticsearch may require additional steps in order to access some of the features. General install and configuration guides are available in [Install Elasticsearch](https://www.elastic.co/elastic/docs-builder/docs/3028/deploy-manage/deploy/self-managed/installing-elasticsearch). Specifically: - To be able to use the GeoIP processor, refer to [the GeoIP processor documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/reference/enrich-processor/geoip-processor#manually-update-geoip-databases) for instructions on downloading and deploying the required databases. - Refer to [Machine learning](#air-gapped-machine-learning) for instructions on deploying the Elastic Learned Sparse EncodeR (ELSER) natural language processing (NLP) model and other trained machine learning models. ## Kibana Air-gapped install of Kibana may require a number of additional services in the local network in order to access some of the features. General install and configuration guides are available in the [Kibana install documentation](https://www.elastic.co/elastic/docs-builder/docs/3028/deploy-manage/deploy/self-managed/install-kibana). Specifically: - To be able to use Kibana mapping visualizations, you need to set up and configure the [Elastic Maps Service](#air-gapped-elastic-maps-service). - To be able to use Kibana sample data, install or update hundreds of prebuilt alert rules, and explore available data integrations, you need to set up and configure the [Elastic Package Registry](#air-gapped-elastic-package-registry). - To provide detection rule updates for Endpoint Security agents, you need to set up and configure the [Elastic Endpoint Artifact Repository](#air-gapped-elastic-endpoint-artifact-repository). - To access the APM integration, you need to set up and configure [Elastic APM](#air-gapped-elastic-apm). - To install and use the Elastic documentation for Kibana AI assistants, you need to set up and configure the [Elastic product documentation for Kibana](#air-gapped-kibana-product-documentation). ## Beats Elastic Beats are light-weight data shippers. They do not require any special configuration in air-gapped environments. To learn more, refer to the [Beats documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/reference/beats). ## Logstash Logstash is a versatile data shipping and processing application. It does not require any special configuration in air-gapped environments. To learn more, refer to the [Logstash documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/reference/logstash). ## Elastic Agent Air-gapped install of Elastic Agent depends on the [Elastic Package Registry](#air-gapped-elastic-package-registry) and the [Elastic Artifact Registry](#air-gapped-elastic-artifact-registry) for most use-cases. The agent itself is fairly lightweight and installs dependencies only as required by its configuration. In terms of connections to these dependencies, Elastic Agents need to be able to connect to the Elastic Artifact Registry directly, but Elastic Package Registry connections are handled through [Kibana](#air-gapped-kibana). Additionally, if the Elastic Agent Elastic Defend integration is used, then access to the [Elastic Endpoint Artifact Repository](#air-gapped-elastic-endpoint-artifact-repository) is necessary in order to deploy updates for some of the detection and prevention capabilities. To learn more about install and configuration, refer to the [Elastic Agent install documentation](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/fleet/install-elastic-agents). Make sure to check the requirements specific to running Elastic Agents in an [air-gapped environment](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/fleet/air-gapped). ## Fleet Server Fleet Server is a required middleware component for any scalable deployment of the Elastic Agent. The air-gapped dependencies of Fleet Server are the same as those of the [Elastic Agent](#air-gapped-elastic-agent). To learn more about installing Fleet Server, refer to the [Fleet Server set up documentation](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/fleet/fleet-server). ## Elastic APM Air-gapped setup of the APM server is possible in two ways: - By setting up one of the Elastic Agent deployments with an APM integration, as described in [Switch a self-installation to the APM integration](https://www.elastic.co/elastic/docs-builder/docs/3028/solutions/observability/apm/switch-self-installation-to-apm-integration). See [air-gapped installation guidance for Elastic Agent](#air-gapped-elastic-agent). - Or, by installing a standalone Elastic APM Server, as described in the [APM configuration documentation](https://www.elastic.co/elastic/docs-builder/docs/3028/solutions/observability/apm/apm-server/configure). ## Elastic Maps Service Refer to [Connect to Elastic Maps Service](https://www.elastic.co/elastic/docs-builder/docs/3028/explore-analyze/visualize/maps/maps-connect-to-ems) in the Kibana documentation to learn how to configure your firewall to connect to Elastic Maps Service, host it locally, or disable it completely. ## Elastic Package Registry Air-gapped install of the EPR is possible using any OCI-compatible runtime like Podman (a typical choice for RHEL-like Linux systems) or Docker. Links to the official container image and usage guide is available on the [Air-gapped environments](https://www.elastic.co/elastic/docs-builder/docs/3028/reference/fleet/air-gapped) page in the Fleet and Elastic Agent Guide. If using Elastic Cloud on Kubernetes, you can follow the instructions in [Deploy Elastic Package Registry on Elastic Cloud on Kubernetes](https://www.elastic.co/elastic/docs-builder/docs/3028/deploy-manage/deploy/cloud-on-k8s/package-registry). Besides setting up the EPR service, you also need to [configure Kibana](#air-gapped-kibana) to use this service. If using TLS with the EPR service, it is also necessary to set up Kibana to trust the certificate presented by the EPR. ### Additional Elastic Package Registry examples The following script generates a SystemD service file on a RHEL 8 system in order to run EPR with Podman in a production environment. ```sh #!/usr/bin/env bash EPR_BIND_ADDRESS="0.0.0.0" EPR_BIND_PORT="8443" EPR_TLS_CERT="/etc/elastic/epr/epr.pem" EPR_TLS_KEY="/etc/elastic/epr/epr-key.pem" EPR_IMAGE="docker.elastic.co/package-registry/distribution:9.3.2" podman create \ --name "elastic-epr" \ -p "$EPR_BIND_ADDRESS:$EPR_BIND_PORT:$EPR_BIND_PORT" \ -v "$EPR_TLS_CERT:/etc/ssl/epr.crt:ro" \ -v "$EPR_TLS_KEY:/etc/ssl/epr.key:ro" \ -e "EPR_ADDRESS=0.0.0.0:$EPR_BIND_PORT" \ -e "EPR_TLS_CERT=/etc/ssl/epr.crt" \ -e "EPR_TLS_KEY=/etc/ssl/epr.key" \ "$EPR_IMAGE" ## creates service file in the root directory # podman generate systemd --new --files --name elastic-epr --restart-policy always ``` Replace `` with the Elastic Stack version number you want. For example, you can replace `` with 9.0.0. ```sh #!/usr/bin/env bash EPR_BIND_ADDRESS="0.0.0.0" EPR_BIND_PORT="8443" EPR_TLS_CERT="/etc/elastic/epr/epr.pem" EPR_TLS_KEY="/etc/elastic/epr/epr-key.pem" EPR_IMAGE="docker.elastic.co/package-registry/distribution:" podman create \ --name "elastic-epr" \ -p "$EPR_BIND_ADDRESS:$EPR_BIND_PORT:$EPR_BIND_PORT" \ -v "$EPR_TLS_CERT:/etc/ssl/epr.crt:ro" \ -v "$EPR_TLS_KEY:/etc/ssl/epr.key:ro" \ -e "EPR_ADDRESS=0.0.0.0:$EPR_BIND_PORT" \ -e "EPR_TLS_CERT=/etc/ssl/epr.crt" \ -e "EPR_TLS_KEY=/etc/ssl/epr.key" \ "$EPR_IMAGE" ## creates service file in the root directory # podman generate systemd --new --files --name elastic-epr --restart-policy always ``` The following is an example of an actual SystemD service file for an EPR, launched as a Podman service. ```ini # container-elastic-epr.service # autogenerated by Podman 4.1.1 # Wed Oct 19 13:12:33 UTC 2022 [Unit] Description=Podman container-elastic-epr.service Documentation=man:podman-generate-systemd(1) Wants=network-online.target After=network-online.target RequiresMountsFor=%t/containers [Service] Environment=PODMAN_SYSTEMD_UNIT=%n Restart=always TimeoutStopSec=70 ExecStartPre=/bin/rm -f %t/%n.ctr-id ExecStart=/usr/bin/podman run \ --cidfile=%t/%n.ctr-id \ --cgroups=no-conmon \ --rm \ --sdnotify=conmon \ -d \ --replace \ --name elastic-epr \ -p 0.0.0.0:8443:8443 \ -v /etc/elastic/epr/epr.pem:/etc/ssl/epr.crt:ro \ -v /etc/elastic/epr/epr-key.pem:/etc/ssl/epr.key:ro \ -e EPR_ADDRESS=0.0.0.0:8443 \ -e EPR_TLS_CERT=/etc/ssl/epr.crt \ -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution:9.3.2 ExecStop=/usr/bin/podman stop --ignore --cidfile=%t/%n.ctr-id ExecStopPost=/usr/bin/podman rm -f --ignore --cidfile=%t/%n.ctr-id Type=notify NotifyAccess=all [Install] WantedBy=default.target ``` Replace `` with the Elastic Stack version number you want. For example, you can replace `` with 9.0.0. ```ini # container-elastic-epr.service # autogenerated by Podman 4.1.1 # Wed Oct 19 13:12:33 UTC 2022 [Unit] Description=Podman container-elastic-epr.service Documentation=man:podman-generate-systemd(1) Wants=network-online.target After=network-online.target RequiresMountsFor=%t/containers [Service] Environment=PODMAN_SYSTEMD_UNIT=%n Restart=always TimeoutStopSec=70 ExecStartPre=/bin/rm -f %t/%n.ctr-id ExecStart=/usr/bin/podman run \ --cidfile=%t/%n.ctr-id \ --cgroups=no-conmon \ --rm \ --sdnotify=conmon \ -d \ --replace \ --name elastic-epr \ -p 0.0.0.0:8443:8443 \ -v /etc/elastic/epr/epr.pem:/etc/ssl/epr.crt:ro \ -v /etc/elastic/epr/epr-key.pem:/etc/ssl/epr.key:ro \ -e EPR_ADDRESS=0.0.0.0:8443 \ -e EPR_TLS_CERT=/etc/ssl/epr.crt \ -e EPR_TLS_KEY=/etc/ssl/epr.key docker.elastic.co/package-registry/distribution: ExecStop=/usr/bin/podman stop --ignore --cidfile=%t/%n.ctr-id ExecStopPost=/usr/bin/podman rm -f --ignore --cidfile=%t/%n.ctr-id Type=notify NotifyAccess=all [Install] WantedBy=default.target ``` ## Elastic Artifact Registry Air-gapped install of the Elastic Artifact Registry is necessary in order to enable Elastic Agent deployments to perform self-upgrades and install certain components which are needed for some of the data integrations (that is, in addition to what is also retrieved from the EPR). To learn more, refer to [Host your own artifact registry for binary downloads](/elastic/docs-builder/docs/3028/reference/fleet/air-gapped#host-artifact-registry) in the Fleet and Elastic Agent Guide. When setting up own web server, such as NGINX, to function as the Elastic Artifact Registry, it is recommended not to use TLS as there are, currently, no direct ways to establish certificate trust between Elastic Agents and this service. ### Additional Elastic Artifact Registry examples The following example script downloads artifacts from the internet to be later served as a private Elastic Package Registry. ```sh #!/usr/bin/env bash set -o nounset -o errexit -o pipefail STACK_VERSION=9.3.2 ARTIFACT_DOWNLOADS_BASE_URL=https://artifacts.elastic.co/downloads DOWNLOAD_BASE_DIR=${DOWNLOAD_BASE_DIR:?"Make sure to set DOWNLOAD_BASE_DIR when running this script"} COMMON_PACKAGE_PREFIXES="apm-server/apm-server beats/auditbeat/auditbeat beats/elastic-agent/elastic-agent beats/filebeat/filebeat beats/heartbeat/heartbeat beats/metricbeat/metricbeat beats/osquerybeat/osquerybeat beats/packetbeat/packetbeat cloudbeat/cloudbeat endpoint-dev/endpoint-security fleet-server/fleet-server" WIN_ONLY_PACKAGE_PREFIXES="beats/winlogbeat/winlogbeat" RPM_PACKAGES="beats/elastic-agent/elastic-agent" DEB_PACKAGES="beats/elastic-agent/elastic-agent" function download_packages() { local url_suffix="$1" local package_prefixes="$2" local _url_suffixes="$url_suffix ${url_suffix}.sha512 ${url_suffix}.asc" local _pkg_dir="" local _dl_url="" for _download_prefix in $package_prefixes; do for _pkg_url_suffix in $_url_suffixes; do _pkg_dir=$(dirname ${DOWNLOAD_BASE_DIR}/${_download_prefix}) _dl_url="${ARTIFACT_DOWNLOADS_BASE_URL}/${_download_prefix}-${_pkg_url_suffix}" (mkdir -p $_pkg_dir && cd $_pkg_dir && curl -O "$_dl_url") done done } # and we download for _os in linux windows; do case "$_os" in linux) PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.tar.gz" ;; windows) PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.zip" ;; *) echo "[ERROR] Something happened" exit 1 ;; esac download_packages "$PKG_URL_SUFFIX" "$COMMON_PACKAGE_PREFIXES" if [[ "$_os" = "windows" ]]; then download_packages "$PKG_URL_SUFFIX" "$WIN_ONLY_PACKAGE_PREFIXES" fi if [[ "$_os" = "linux" ]]; then download_packages "${STACK_VERSION}-x86_64.rpm" "$RPM_PACKAGES" download_packages "${STACK_VERSION}-amd64.deb" "$DEB_PACKAGES" fi done ## selinux tweaks # semanage fcontext -a -t "httpd_sys_content_t" '/opt/elastic-packages(/.*)?' # restorecon -Rv /opt/elastic-packages ``` Replace `` with the Elastic Stack version number you want. For example, you can replace `` with 9.0.0. ```sh #!/usr/bin/env bash set -o nounset -o errexit -o pipefail STACK_VERSION= ARTIFACT_DOWNLOADS_BASE_URL=https://artifacts.elastic.co/downloads DOWNLOAD_BASE_DIR=${DOWNLOAD_BASE_DIR:?"Make sure to set DOWNLOAD_BASE_DIR when running this script"} COMMON_PACKAGE_PREFIXES="apm-server/apm-server beats/auditbeat/auditbeat beats/elastic-agent/elastic-agent beats/filebeat/filebeat beats/heartbeat/heartbeat beats/metricbeat/metricbeat beats/osquerybeat/osquerybeat beats/packetbeat/packetbeat cloudbeat/cloudbeat endpoint-dev/endpoint-security fleet-server/fleet-server" WIN_ONLY_PACKAGE_PREFIXES="beats/winlogbeat/winlogbeat" RPM_PACKAGES="beats/elastic-agent/elastic-agent" DEB_PACKAGES="beats/elastic-agent/elastic-agent" function download_packages() { local url_suffix="$1" local package_prefixes="$2" local _url_suffixes="$url_suffix ${url_suffix}.sha512 ${url_suffix}.asc" local _pkg_dir="" local _dl_url="" for _download_prefix in $package_prefixes; do for _pkg_url_suffix in $_url_suffixes; do _pkg_dir=$(dirname ${DOWNLOAD_BASE_DIR}/${_download_prefix}) _dl_url="${ARTIFACT_DOWNLOADS_BASE_URL}/${_download_prefix}-${_pkg_url_suffix}" (mkdir -p $_pkg_dir && cd $_pkg_dir && curl -O "$_dl_url") done done } # and we download for _os in linux windows; do case "$_os" in linux) PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.tar.gz" ;; windows) PKG_URL_SUFFIX="${STACK_VERSION}-${_os}-x86_64.zip" ;; *) echo "[ERROR] Something happened" exit 1 ;; esac download_packages "$PKG_URL_SUFFIX" "$COMMON_PACKAGE_PREFIXES" if [[ "$_os" = "windows" ]]; then download_packages "$PKG_URL_SUFFIX" "$WIN_ONLY_PACKAGE_PREFIXES" fi if [[ "$_os" = "linux" ]]; then download_packages "${STACK_VERSION}-x86_64.rpm" "$RPM_PACKAGES" download_packages "${STACK_VERSION}-amd64.deb" "$DEB_PACKAGES" fi done ## selinux tweaks # semanage fcontext -a -t "httpd_sys_content_t" '/opt/elastic-packages(/.*)?' # restorecon -Rv /opt/elastic-packages ``` The following is an example NGINX configuration for running a web server for the Elastic Artifact Registry. ```sh user nginx; worker_processes 2; error_log /var/log/nginx/error.log notice; pid /var/run/nginx.pid; events { worker_connections 1024; } http { include /etc/nginx/mime.types; default_type application/octet-stream; log_format main '$remote_addr - $remote_user [$time_local] "$request" ' '$status $body_bytes_sent "$http_referer" ' '"$http_user_agent" "$http_x_forwarded_for"'; access_log /var/log/nginx/access.log main; sendfile on; keepalive_timeout 65; server { listen 9080 default_server; server_name _; root /opt/elastic-packages; location / { } } } ``` ## Elastic Endpoint Artifact Repository Air-gapped setup of this component is, essentially, identical to the setup of the [Elastic Artifact Registry](#air-gapped-elastic-artifact-registry) except that different artifacts are served. To learn more, refer to [Configure offline endpoints and air-gapped environments](https://www.elastic.co/elastic/docs-builder/docs/3028/solutions/security/configure-elastic-defend/configure-offline-endpoints-air-gapped-environments) in the Elastic Security guide. ## Machine learning Some machine learning features, like natural language processing (NLP), require you to deploy trained models. To learn about deploying machine learning models in an air-gapped environment, refer to: - [Deploy ELSER in an air-gapped environment](/elastic/docs-builder/docs/3028/explore-analyze/machine-learning/nlp/ml-nlp-elser#air-gapped-install). - [Install trained models in an air-gapped environment with Eland](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/3028/reference/elasticsearch/clients/eland/machine-learning#ml-nlp-pytorch-air-gapped). ## Kibana Product documentation for AI Assistants Installing the AI Assistant knowledge base content (Elastic documentation and Security Labs) requires network access to the artifact repository at `https://kibana-knowledge-base-artifacts.elastic.co/`. If you don't have access, which is common for deployments in air-gapped or restricted networks, you must deploy the knowledge base artifact repository manually. For details, refer to [Host a knowledge base artifact repo for AI assistants](https://www.elastic.co/elastic/docs-builder/docs/3028/explore-analyze/ai-features/ai-chat-experiences/ai-assistant-host-doc-artifacts).