github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: Fix inconsistencies in setup docs

Browse source 
The configuration headers are now consistent across targz/zip/deb/rpm,
and KIBANA_HOME variables are used consistently as well.
This commit is contained in:
Court Ewing 2016-10-25 14:23:26 -04:00
parent 6d5335c51a
commit 95cb943e08
4 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/setup/install/deb.asciidoc
View file

@ -145,7 +145,7 @@ failure to STDOUT. Log files can be found in `/var/log/kibana/`.
include::systemd.asciidoc[]
[[deb-configuring]]
==== Configuring Kibana
==== Configuring Kibana via config file
Kibana loads its configuration from the `/etc/kibana/kibana.yml`
file by default. The format of this config file is explained in

2
docs/setup/install/rpm.asciidoc
View file

@ -137,7 +137,7 @@ failure to STDOUT. Log files can be found in `/var/log/kibana/`.
include::systemd.asciidoc[]
[[rpm-configuring]]
==== Configuring Kibana
==== Configuring Kibana via config file
Kibana loads its configuration from the `/etc/kibana/kibana.yml`
file by default. The format of this config file is explained in

16
docs/setup/install/targz.asciidoc
View file

@ -80,7 +80,7 @@ The Darwin archive for Kibana v{version} can be downloaded and installed as foll
["source","sh",subs="attributes"]
--------------------------------------------
wget https://artifacts.elastic.co/downloads/kibana/kibana-{version}-darwin-x86_64.tar.gz
sha1sum kibana-{version}-darwin-x86_64.tar.gz <1>
shasum kibana-{version}-darwin-x86_64.tar.gz <1>
tar -xzf kibana-{version}-darwin-x86_64.tar.gz
cd kibana/ <2>
--------------------------------------------
@ -106,7 +106,7 @@ standard output (`stdout`), and can be stopped by pressing `Ctrl-C`.
[[targz-configuring]]
==== Configuring Kibana on the command line
==== Configuring Kibana via 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
@ -131,35 +131,35 @@ important data later on.
|=======================================================================
| Type | Description | Default Location | Setting
| home
| Kibana home directory or `%KIBANA_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
| $KIBANA_HOME\bin
d|
| config
| Configuration files including `kibana.yml`
| %KIBANA_HOME%\config
| $KIBANA_HOME\config
d|
| data
| The location of the data files written to disk by Kibana and its plugins
| %KIBANA_HOME%\data
| $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
| $KIBANA_HOME\optimize
d|
| plugins
| Plugin files location. Each plugin will be contained in a subdirectory.
| %KIBANA_HOME%\plugins
| $KIBANA_HOME\plugins
d|
|=======================================================================

24
docs/setup/install/windows.asciidoc
View file

@ -23,8 +23,8 @@ 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:
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"]
@ -48,9 +48,9 @@ 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
==== Configuring Kibana via config file
Kibana loads its configuration from the `%KIBANA_HOME%/config/kibana.yml`
Kibana loads its configuration from the `$KIBANA_HOME/config/kibana.yml`
file by default. The format of this config file is explained in
<<settings>>.
@ -58,12 +58,12 @@ file by default. The format of this config file is explained in
==== 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
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
`$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.
@ -72,35 +72,35 @@ important data later on.
|=======================================================================
| Type | Description | Default Location | Setting
| home
| Kibana home directory or `%KIBANA_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
| $KIBANA_HOME\bin
d|
| config
| Configuration files including `kibana.yml`
| %KIBANA_HOME%\config
| $KIBANA_HOME\config
d|
| data
| The location of the data files written to disk by Kibana and its plugins
| %KIBANA_HOME%\data
| $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
| $KIBANA_HOME\optimize
d|
| plugins
| Plugin files location. Each plugin will be contained in a subdirectory.
| %KIBANA_HOME%\plugins
| $KIBANA_HOME\plugins
d|
|=======================================================================