mirror of
https://github.com/elastic/kibana.git
synced 2025-04-23 17:28:26 -04:00
79ee6dc6e7
# Backport This will backport the following commits from `main` to `8.9`: - [Clarify macOS support (#191329)](https://github.com/elastic/kibana/pull/191329) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Pius","email":"pius@elastic.co"},"sourceCommit":{"committedDate":"2024-08-28T12:55:38Z","message":"Clarify macOS support (#191329)\n\nClarifying macOS support is limited to development environments only.\r\n\r\nPlease back-port accordingly. Thx!","sha":"874f5ac3cb755af32ae45401d0819d93afee30d0","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","docs","v8.0.2","v8.1.4","v8.2.4","v8.3.4","v8.4.4","v8.5.4","v8.6.3","v8.7.2","v8.8.3","v8.9.3","v8.11.1","v8.10.5","v8.12.3","v8.13.5","v8.16.0","v8.14.4","v7.17.24","v8.15.1","backport:version"],"title":"Clarify macOS support","number":191329,"url":"https://github.com/elastic/kibana/pull/191329","mergeCommit":{"message":"Clarify macOS support (#191329)\n\nClarifying macOS support is limited to development environments only.\r\n\r\nPlease back-port accordingly. Thx!","sha":"874f5ac3cb755af32ae45401d0819d93afee30d0"}},"sourceBranch":"main","suggestedTargetBranches":["8.0","8.1","8.2","8.3","8.4","8.5","8.6","8.7","8.8","8.9","8.11","8.10","8.12","8.13","8.14","7.17","8.15"],"targetPullRequestStates":[{"branch":"8.0","label":"v8.0.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.1","label":"v8.1.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.2","label":"v8.2.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.3","label":"v8.3.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.4","label":"v8.4.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.5","label":"v8.5.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.6","label":"v8.6.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.7","label":"v8.7.2","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.8","label":"v8.8.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.9","label":"v8.9.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.11","label":"v8.11.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.10","label":"v8.10.5","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.12","label":"v8.12.3","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.13","label":"v8.13.5","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/191329","number":191329,"mergeCommit":{"message":"Clarify macOS support (#191329)\n\nClarifying macOS support is limited to development environments only.\r\n\r\nPlease back-port accordingly. Thx!","sha":"874f5ac3cb755af32ae45401d0819d93afee30d0"}},{"branch":"8.14","label":"v8.14.4","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"7.17","label":"v7.17.24","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.15","label":"v8.15.1","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Pius <pius@elastic.co>
155 lines
5.1 KiB
Text
155 lines
5.1 KiB
Text
[[targz]]
|
||
=== Install {kib} from archive on Linux or macOS
|
||
++++
|
||
<titleabbrev>Install from archive on Linux or macOS</titleabbrev>
|
||
++++
|
||
|
||
Kibana is provided for Linux and Darwin as a `.tar.gz` package. These packages
|
||
are the easiest formats to use when trying out Kibana.
|
||
|
||
This package contains both free and subscription features.
|
||
<<managing-licenses,Start a 30-day trial>> to try out all of the features.
|
||
|
||
The latest stable version of Kibana can be found on the
|
||
link:/downloads/kibana[Download Kibana] page.
|
||
Other versions can be found on the
|
||
link:/downloads/past-releases[Past Releases page].
|
||
|
||
[NOTE]
|
||
====
|
||
macOS is supported for development purposes only and is not covered under the support SLA for link:https://www.elastic.co/support/matrix#kibana[production-supported operating systems].
|
||
====
|
||
|
||
[[install-linux64]]
|
||
==== Download and install the Linux 64-bit package
|
||
|
||
ifeval::["{release-state}"=="unreleased"]
|
||
|
||
Version {version} of Kibana has not yet been released.
|
||
|
||
endif::[]
|
||
|
||
ifeval::["{release-state}"!="unreleased"]
|
||
|
||
The Linux archive for Kibana v{version} can be downloaded and installed as follows:
|
||
|
||
["source","sh",subs="attributes"]
|
||
--------------------------------------------
|
||
curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{version}-linux-x86_64.tar.gz
|
||
curl https://artifacts.elastic.co/downloads/kibana/kibana-{version}-linux-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
|
||
tar -xzf kibana-{version}-linux-x86_64.tar.gz
|
||
cd kibana-{version}/ <2>
|
||
--------------------------------------------
|
||
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
|
||
`kibana-{version}-linux-x86_64.tar.gz: OK`.
|
||
<2> This directory is known as `$KIBANA_HOME`.
|
||
|
||
endif::[]
|
||
|
||
|
||
[[install-darwin64]]
|
||
==== Download and install the Darwin package
|
||
|
||
[IMPORTANT]
|
||
.macOS Gatekeeper warnings
|
||
====
|
||
Apple's rollout of stricter notarization requirements affected the notarization
|
||
of the {version} {kib} artifacts. If macOS displays a dialog when you
|
||
first run {kib} that interrupts it, you will need to take an action to allow it
|
||
to run.
|
||
|
||
To prevent Gatekeeper checks on the {kib} files, run the following command on the
|
||
downloaded `.tar.gz` archive or the directory to which was extracted:
|
||
[source,sh]
|
||
----
|
||
xattr -d -r com.apple.quarantine <archive-or-directory>
|
||
----
|
||
|
||
Alternatively, you can add a security override if a Gatekeeper popup appears by
|
||
following the instructions in the _How to open an app that hasn’t been notarized
|
||
or is from an unidentified developer_ section of
|
||
https://support.apple.com/en-us/HT202491[Safely open apps on your Mac].
|
||
====
|
||
|
||
ifeval::["{release-state}"=="unreleased"]
|
||
|
||
Version {version} of Kibana has not yet been released.
|
||
|
||
endif::[]
|
||
|
||
ifeval::["{release-state}"!="unreleased"]
|
||
|
||
The Darwin archive for Kibana v{version} can be downloaded and installed as follows:
|
||
|
||
["source","sh",subs="attributes"]
|
||
--------------------------------------------
|
||
curl -O https://artifacts.elastic.co/downloads/kibana/kibana-{version}-darwin-x86_64.tar.gz
|
||
curl https://artifacts.elastic.co/downloads/kibana/kibana-{version}-darwin-x86_64.tar.gz.sha512 | shasum -a 512 -c - <1>
|
||
tar -xzf kibana-{version}-darwin-x86_64.tar.gz
|
||
cd kibana-{version}/ <2>
|
||
--------------------------------------------
|
||
<1> Compares the SHA of the downloaded `.tar.gz` archive and the published checksum, which should output
|
||
`kibana-{version}-darwin-x86_64.tar.gz: OK`.
|
||
<2> This directory is known as `$KIBANA_HOME`.
|
||
|
||
endif::[]
|
||
|
||
[[targz-enroll]]
|
||
include::start-es-and-enroll.asciidoc[]
|
||
|
||
[[targz-running]]
|
||
include::targz-running.asciidoc[]
|
||
|
||
|
||
[[targz-configuring]]
|
||
==== Configure {kib} via the config file
|
||
|
||
Kibana loads its configuration from the `$KIBANA_HOME/config/kibana.yml`
|
||
file by default. The format of this config file is explained in
|
||
{kibana-ref}/settings.html[Configuring Kibana].
|
||
|
||
|
||
[[targz-layout]]
|
||
==== Directory layout of `.tar.gz` archives
|
||
|
||
The `.tar.gz` packages are entirely self-contained. All files and directories
|
||
are, by default, contained within `$KIBANA_HOME` -- the directory created when
|
||
unpacking the archive.
|
||
|
||
This is very convenient because you don't have to create any directories to
|
||
start using Kibana, and uninstalling Kibana is as easy as removing the
|
||
`$KIBANA_HOME` directory. However, it is advisable to change the default
|
||
locations of the config and data directories so that you do not delete
|
||
important data later on.
|
||
|
||
|
||
[cols="<h,<,<m,<m",options="header",]
|
||
|=======================================================================
|
||
| Type | Description | Default Location | Setting
|
||
| home
|
||
| Kibana home directory or `$KIBANA_HOME`
|
||
d| Directory created by unpacking the archive
|
||
|
|
||
|
||
| bin
|
||
| Binary scripts including `kibana` to start the Kibana server
|
||
and `kibana-plugin` to install plugins
|
||
| $KIBANA_HOME\bin
|
||
d|
|
||
|
||
| config
|
||
| Configuration files including `kibana.yml`
|
||
| $KIBANA_HOME\config
|
||
| <<settings,KBN_PATH_CONF>>
|
||
|
||
| data
|
||
| The location of the data files written to disk by Kibana and its plugins
|
||
| $KIBANA_HOME\data
|
||
d|
|
||
|
||
| plugins
|
||
| Plugin files location. Each plugin will be contained in a subdirectory.
|
||
| $KIBANA_HOME\plugins
|
||
d|
|
||
|
||
|=======================================================================
|