Skip to content

Commit a5ce0f0

Browse files
[9.1] [DOCS] Add kibana-setup CLI documentation (elastic#235122) (elastic#235195)
# Backport This will backport the following commits from `main` to `9.1`: - [[DOCS] Add kibana-setup CLI documentation (elastic#235122)](elastic#235122) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Copilot","email":"[email protected]"},"sourceCommit":{"committedDate":"2025-09-16T12:08:21Z","message":"[DOCS] Add kibana-setup CLI documentation (elastic#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9","branchLabelMapping":{"^v9.2.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","💝community","docs","backport:prev-minor","v9.2.0"],"title":"[DOCS] Add kibana-setup CLI documentation","number":235122,"url":"https://github.com/elastic/kibana/pull/235122","mergeCommit":{"message":"[DOCS] Add kibana-setup CLI documentation (elastic#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.2.0","branchLabelMappingKey":"^v9.2.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/235122","number":235122,"mergeCommit":{"message":"[DOCS] Add kibana-setup CLI documentation (elastic#235122)","sha":"6e08de85f08e1d74f01518ab352f940a9198fbd9"}}]}] BACKPORT--> Co-authored-by: Copilot <[email protected]>
1 parent 91c0e2f commit a5ce0f0

File tree

3 files changed

+69
-0
lines changed

3 files changed

+69
-0
lines changed

docs/reference/commands.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ mapped_pages:
88
{{kib}} provides the following tools for configuring security and performing other tasks from the command line:
99

1010
* [`kibana-encryption-keys`](/reference/commands/kibana-encryption-keys.md)
11+
* [`kibana-setup`](/reference/commands/kibana-setup.md)
1112
* [`kibana-verification-code`](/reference/commands/kibana-verification-code.md)
1213

1314

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
---
2+
navigation_title: kibana-setup
3+
applies_to:
4+
deployment:
5+
self: ga
6+
products:
7+
- id: kibana
8+
---
9+
10+
# kibana-setup [kibana-setup]
11+
12+
The `kibana-setup` tool walks you through all required steps to securely connect {{kib}} with {{es}}.
13+
14+
15+
## Synopsis [_synopsis]
16+
17+
```shell
18+
bin/kibana-setup
19+
[-t, --enrollment-token <token>] [-s, --silent]
20+
[-V, --version] [-h, --help]
21+
```
22+
23+
24+
## Description [_description]
25+
26+
Use this command to configure a secure connection between {{kib}} and {{es}}. The tool guides you through the process of enrolling {{kib}} with a secured {{es}} cluster using an enrollment token. This is particularly useful for initial setup and configuration of {{kib}} in secured environments.
27+
28+
::::{important}
29+
You must have an enrollment token generated from your {{es}} cluster before running this command.
30+
::::
31+
32+
33+
34+
## Parameters [kibana-setup-parameters]
35+
36+
`-t, --enrollment-token <token>`
37+
: Elasticsearch enrollment token to use for configuring the connection.
38+
39+
`-s, --silent`
40+
: Prevent all logging output during the setup process.
41+
42+
`-h, --help`
43+
: Returns all of the command parameters.
44+
45+
`-V, --version`
46+
: Displays the {{kib}} version number.
47+
48+
49+
## Examples [_examples_2]
50+
51+
The following command runs the interactive setup process:
52+
53+
```shell
54+
bin/kibana-setup
55+
```
56+
57+
The following command configures {{kib}} with a specific enrollment token:
58+
59+
```shell
60+
bin/kibana-setup --enrollment-token <your-enrollment-token>
61+
```
62+
63+
The following command runs setup silently with an enrollment token:
64+
65+
```shell
66+
bin/kibana-setup --enrollment-token <your-enrollment-token> --silent
67+
```

docs/reference/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ toc:
6565
- file: commands.md
6666
children:
6767
- file: commands/kibana-encryption-keys.md
68+
- file: commands/kibana-setup.md
6869
- file: commands/kibana-verification-code.md
6970
- file: osquery-exported-fields.md
7071
- file: osquery-manager-prebuilt-packs.md

0 commit comments

Comments
 (0)