Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ mapped_pages:
{{kib}} provides the following tools for configuring security and performing other tasks from the command line:

* [`kibana-encryption-keys`](/reference/commands/kibana-encryption-keys.md)
* [`kibana-setup`](/reference/commands/kibana-setup.md)
* [`kibana-verification-code`](/reference/commands/kibana-verification-code.md)


Expand Down
67 changes: 67 additions & 0 deletions docs/reference/commands/kibana-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
navigation_title: kibana-setup
applies_to:
deployment:
self: ga
products:
- id: kibana
---

# kibana-setup [kibana-setup]

The `kibana-setup` tool walks you through all required steps to securely connect {{kib}} with {{es}}.


## Synopsis [_synopsis]

```shell
bin/kibana-setup
[-t, --enrollment-token <token>] [-s, --silent]
[-V, --version] [-h, --help]
```


## Description [_description]

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.

::::{important}
You must have an enrollment token generated from your {{es}} cluster before running this command.
::::



## Parameters [kibana-setup-parameters]

`-t, --enrollment-token <token>`
: Elasticsearch enrollment token to use for configuring the connection.

`-s, --silent`
: Prevent all logging output during the setup process.

`-h, --help`
: Returns all of the command parameters.

`-V, --version`
: Displays the {{kib}} version number.


## Examples [_examples_2]

The following command runs the interactive setup process:

```shell
bin/kibana-setup
```

The following command configures {{kib}} with a specific enrollment token:

```shell
bin/kibana-setup --enrollment-token <your-enrollment-token>
```

The following command runs setup silently with an enrollment token:

```shell
bin/kibana-setup --enrollment-token <your-enrollment-token> --silent
```
1 change: 1 addition & 0 deletions docs/reference/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ toc:
- file: commands.md
children:
- file: commands/kibana-encryption-keys.md
- file: commands/kibana-setup.md
- file: commands/kibana-verification-code.md
- file: osquery-exported-fields.md
- file: osquery-manager-prebuilt-packs.md
Loading