Skip to content

Commit ee5f8b6

Browse files
committed
[chore] Added stateful startup options to docs
1 parent d4d55ad commit ee5f8b6

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

dev_docs/getting_started/setting_up_a_development_env.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,52 @@ yarn start
7878
Include developer [examples](https://github.com/elastic/kibana/tree/main/examples) by adding an optional `--run-examples` flag. Read more about the advanced options for [Running Kibana](https://www.elastic.co/guide/en/kibana/current/running-kibana-advanced.html).
7979
You will find the development server running on (http://localhost:5601) - and you can log in with the `elastic:changeme` credential pair.
8080

81+
### Stateful startup options
82+
83+
The following combinations cover the most common local development scenarios.
84+
85+
**Default** — both SAML and basic login are supported; SAML is the default:
86+
87+
```sh
88+
yarn es snapshot
89+
yarn start
90+
```
91+
92+
**Without SAML login** — only basic login:
93+
94+
```sh
95+
yarn es snapshot
96+
yarn start --mockIdpPlugin.enabled=false
97+
```
98+
99+
**Basic license** — only basic login is supported:
100+
101+
```sh
102+
yarn es snapshot --license basic
103+
yarn start --mockIdpPlugin.enabled=false
104+
```
105+
106+
**No base path** — basic license, basic login, no random dev basepath:
107+
108+
```sh
109+
yarn es snapshot --license basic
110+
yarn start --mockIdpPlugin.enabled=false --no-base-path
111+
```
112+
113+
**Custom base path** — both SAML and basic login are supported; SAML is the default.
114+
115+
```sh
116+
yarn es snapshot --kibanaUrl http://localhost:5601/your_path
117+
yarn start --server.basePath=/your_path
118+
```
119+
120+
**No base path with SAML** — both SAML and basic login are supported; SAML is the default:
121+
122+
```sh
123+
yarn es snapshot --kibanaUrl http://localhost:5601/
124+
yarn start --no-base-path
125+
```
126+
81127
## Run in serverless mode
82128

83129
To develop against serverless projects, you need to start both Elasticsearch and Kibana in serverless mode with matching project types.

0 commit comments

Comments
 (0)