Skip to content

Commit

Permalink
Fix path.conf in docs to path.config (#4547)
Browse files Browse the repository at this point in the history
In some docs file `path.conf` instead of `path.config` was mentioned. To reduce confusion I also changed the type from `conf` to `config`.
  • Loading branch information
ruflin authored and exekias committed Jun 23, 2017
1 parent 51d8637 commit b224a3c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
48 changes: 24 additions & 24 deletions libbeat/docs/shared-directory-layout.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ The directory layout of an installation is as follows:

[cols="<h,<,<m,<m",options="header",]
|=======================================================================
| Type | Description | Default Location | Config Option
| home | Home of the {beatname_uc} installation. | | path.home
| bin | The location for the binary files. | {path.home} |
| conf | The location for configuration files. | {path.home} | path.conf
| data | The location for persistent data files. | {path.home}/data| path.data
| logs | The location for the logs created by {beatname_uc}. | {path.home}/logs | path.logs
| Type | Description | Default Location | Config Option
| home | Home of the {beatname_uc} installation. | | path.home
| bin | The location for the binary files. | {path.home} |
| config | The location for configuration files. | {path.home} | path.config
| data | The location for persistent data files. | {path.home}/data| path.data
| logs | The location for the logs created by {beatname_uc}. | {path.home}/logs | path.logs
|=======================================================================

You can change these settings by using CLI flags or setting <<configuration-path,path options>> in the configuration
Expand All @@ -35,12 +35,12 @@ file.
===== deb and rpm
[cols="<h,<,<m",options="header",]
|=======================================================================
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | /usr/share/{beatname_lc}
| bin | The location for the binary files. | /usr/share/{beatname_lc}
| conf | The location for configuration files. | /etc/{beatname_lc}
| data | The location for persistent data files. | /var/lib/{beatname_lc}
| logs | The location for the logs created by {beatname_uc}. | /var/log/{beatname_lc}
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | /usr/share/{beatname_lc}
| bin | The location for the binary files. | /usr/share/{beatname_lc}
| config | The location for configuration files. | /etc/{beatname_lc}
| data | The location for persistent data files. | /var/lib/{beatname_lc}
| logs | The location for the logs created by {beatname_uc}. | /var/log/{beatname_lc}
|=======================================================================

For the deb and rpm distributions, these paths are set in the init script or in
Expand All @@ -52,24 +52,24 @@ Otherwise the paths might be set incorrectly.
===== docker
[cols="<h,<,<m",options="header",]
|=======================================================================
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | /usr/share/{beatname_lc}
| bin | The location for the binary files. | /usr/share/{beatname_lc}
| conf | The location for configuration files. | /usr/share/{beatname_lc}
| data | The location for persistent data files. | /usr/share/{beatname_lc}/data
| logs | The location for the logs created by {beatname_uc}. | /usr/share//{beatname_lc}/logs
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | /usr/share/{beatname_lc}
| bin | The location for the binary files. | /usr/share/{beatname_lc}
| config | The location for configuration files. | /usr/share/{beatname_lc}
| data | The location for persistent data files. | /usr/share/{beatname_lc}/data
| logs | The location for the logs created by {beatname_uc}. | /usr/share//{beatname_lc}/logs
|=======================================================================

[float]
===== zip, tar.gz, and tgz
[cols="<h,<,<m",options="header",]
|=======================================================================
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | {extract.path}
| bin | The location for the binary files. | {extract.path}
| conf | The location for configuration files. | {extract.path}
| data | The location for persistent data files. | {extract.path}/data
| logs | The location for the logs created by {beatname_uc}. | {extract.path}/logs
| Type | Description | Location
| home | Home of the {beatname_uc} installation. | {extract.path}
| bin | The location for the binary files. | {extract.path}
| config | The location for configuration files. | {extract.path}
| data | The location for persistent data files. | {extract.path}/data
| logs | The location for the logs created by {beatname_uc}. | {extract.path}/logs
|=======================================================================

For the zip, tar.gz and tgz distributions, these paths are based on the location of the
Expand Down
6 changes: 3 additions & 3 deletions libbeat/docs/shared-path-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ Here is an example configuration:
[source,yaml]
------------------------------------------------------------------------------
path.home: /usr/share/beat
path.conf: /etc/beat
path.config: /etc/beat
path.data: /var/lib/beat
path.logs: /var/log/
------------------------------------------------------------------------------

Note that it is possible to override these options by using command line flags.
Note that it is possible to override these options by using command line flags.

==== Path Options

Expand Down Expand Up @@ -62,7 +62,7 @@ Example:

[source,yaml]
------------------------------------------------------------------------------
path.conf: /usr/share/beats/config
path.config: /usr/share/beats/config
------------------------------------------------------------------------------

===== data
Expand Down

0 comments on commit b224a3c

Please sign in to comment.