8895ae110f
This overhaul of the docs structure puts Kibana's documentation more inline with the structure that is used in Elasticsearch. This will help us better organize the docs going forward as more docs are added. This also includes a few necessary content changes for 5.0.
107 lines
3.1 KiB
Plaintext
107 lines
3.1 KiB
Plaintext
[[windows]]
|
|
=== Install Kibana on Windows
|
|
|
|
Kibana can be installed on Windows using the `.zip` package.
|
|
|
|
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].
|
|
|
|
[[install-windows]]
|
|
==== Download and install the `.zip` package
|
|
|
|
ifeval::["{release-state}"=="unreleased"]
|
|
|
|
Version {version} of Kibana has not yet been released.
|
|
|
|
endif::[]
|
|
|
|
ifeval::["{release-state}"!="unreleased"]
|
|
|
|
Download the `.zip` windows archive for Kibana v{version} from
|
|
https://artifacts.elastic.co/downloads/kibana/kibana-{version}-windows-x86.zip
|
|
|
|
Unzip it with your favourite unzip tool. This will create a folder called
|
|
kibana-{version}-windows-x86, which we will refer to as `%KIBANA_HOME%`. In a
|
|
terminal window, `CD` to the `%KIBANA_HOME%` directory, for instance:
|
|
|
|
|
|
["source","sh",subs="attributes"]
|
|
----------------------------
|
|
CD c:\kibana-{version}-windows-x86
|
|
----------------------------
|
|
|
|
endif::[]
|
|
|
|
[[windows-running]]
|
|
==== Running Kibana from the command line
|
|
|
|
Kibana can be started from the command line as follows:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
.\bin\kibana
|
|
--------------------------------------------
|
|
|
|
By default, Kibana runs in the foreground, prints its logs to `STDOUT`,
|
|
and can be stopped by pressing `Ctrl-C`.
|
|
|
|
[[windows-configuring]]
|
|
==== Configuring Kibana on the command line
|
|
|
|
Kibana loads its configuration from the `%KIBANA_HOME%/config/kibana.yml`
|
|
file by default. The format of this config file is explained in
|
|
<<settings>>.
|
|
|
|
[[windows-layout]]
|
|
==== Directory layout of `.zip` archive
|
|
|
|
The `.zip` package is 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
|
|
d|
|
|
|
|
| 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
|
|
d|
|
|
|
|
| data
|
|
| The location of the data files written to disk by Kibana and its plugins
|
|
| %KIBANA_HOME%\data
|
|
d|
|
|
|
|
| optimize
|
|
| Transpiled source code. Certain administrative actions (e.g. plugin install)
|
|
result in the source code being retranspiled on the fly.
|
|
| %KIBANA_HOME%\optimize
|
|
d|
|
|
|
|
| plugins
|
|
| Plugin files location. Each plugin will be contained in a subdirectory.
|
|
| %KIBANA_HOME%\plugins
|
|
d|
|
|
|
|
|=======================================================================
|