2020-07-13 16:47:01 +02:00
|
|
|
|
[[running-kibana-advanced]]
|
2020-07-16 16:13:51 +02:00
|
|
|
|
== Running {kib}
|
2020-07-13 16:47:01 +02:00
|
|
|
|
|
|
|
|
|
Change to your local {kib} directory. Start the development server.
|
|
|
|
|
|
|
|
|
|
[source,bash]
|
|
|
|
|
----
|
|
|
|
|
yarn start
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
____
|
|
|
|
|
On Windows, you’ll need to use Git Bash, Cygwin, or a similar shell that
|
|
|
|
|
exposes the `sh` command. And to successfully build you’ll need Cygwin
|
|
|
|
|
optional packages zip, tar, and shasum.
|
|
|
|
|
____
|
|
|
|
|
|
|
|
|
|
Now you can point your web browser to http://localhost:5601 and start
|
|
|
|
|
using {kib}! When running `yarn start`, {kib} will also log that it
|
|
|
|
|
is listening on port 5603 due to the base path proxy, but you should
|
|
|
|
|
still access {kib} on port 5601.
|
|
|
|
|
|
|
|
|
|
By default, you can log in with username `elastic` and password
|
|
|
|
|
`changeme`. See the `--help` options on `yarn es <command>` if
|
|
|
|
|
you’d like to configure a different password.
|
|
|
|
|
|
2020-07-16 16:13:51 +02:00
|
|
|
|
[discrete]
|
|
|
|
|
=== Unsupported URL Type
|
2020-07-13 16:47:01 +02:00
|
|
|
|
|
|
|
|
|
If you’re installing dependencies and seeing an error that looks
|
|
|
|
|
something like
|
|
|
|
|
|
|
|
|
|
....
|
2020-08-31 21:13:06 +02:00
|
|
|
|
Unsupported URL Type: link:packages/elastic-eslint-config-kibana
|
2020-07-13 16:47:01 +02:00
|
|
|
|
....
|
|
|
|
|
|
|
|
|
|
you’re likely running `npm`. To install dependencies in {kib} you
|
|
|
|
|
need to run `yarn kbn bootstrap`. For more info, see
|
|
|
|
|
link:#setting-up-your-development-environment[Setting Up Your
|
|
|
|
|
Development Environment] above.
|
|
|
|
|
|
2020-07-16 16:13:51 +02:00
|
|
|
|
[discrete]
|
2020-07-13 16:47:01 +02:00
|
|
|
|
[[customize-kibana-yml]]
|
2020-07-16 16:13:51 +02:00
|
|
|
|
=== Customizing `config/kibana.dev.yml`
|
2020-07-13 16:47:01 +02:00
|
|
|
|
|
|
|
|
|
The `config/kibana.yml` file stores user configuration directives.
|
|
|
|
|
Since this file is checked into source control, however, developer
|
|
|
|
|
preferences can’t be saved without the risk of accidentally committing
|
|
|
|
|
the modified version. To make customizing configuration easier during
|
|
|
|
|
development, the {kib} CLI will look for a `config/kibana.dev.yml`
|
|
|
|
|
file if run with the `--dev` flag. This file behaves just like the
|
|
|
|
|
non-dev version and accepts any of the
|
|
|
|
|
https://www.elastic.co/guide/en/kibana/current/settings.html[standard
|
|
|
|
|
settings].
|
|
|
|
|
|
2020-07-16 16:13:51 +02:00
|
|
|
|
[discrete]
|
|
|
|
|
=== Potential Optimization Pitfalls
|
2020-07-13 16:47:01 +02:00
|
|
|
|
|
2020-08-26 15:30:47 +02:00
|
|
|
|
* Webpack is trying to include a file in the bundle that was deleted and
|
|
|
|
|
is now complaining about it being missing
|
2020-07-13 16:47:01 +02:00
|
|
|
|
* A module id that used to resolve to a single file now resolves to a
|
|
|
|
|
directory, but webpack isn’t adapting
|
|
|
|
|
* (if you discover other scenarios, please send a PR!)
|
|
|
|
|
|
2020-07-16 16:13:51 +02:00
|
|
|
|
[discrete]
|
|
|
|
|
=== Setting Up SSL
|
2020-07-13 16:47:01 +02:00
|
|
|
|
|
|
|
|
|
{kib} includes self-signed certificates that can be used for
|
|
|
|
|
development purposes in the browser and for communicating with
|
2020-08-26 15:30:47 +02:00
|
|
|
|
{es}: `yarn start --ssl` & `yarn es snapshot --ssl`.
|