diff --git a/docs/setup/settings.asciidoc b/docs/setup/settings.asciidoc index 4011470013a7..1b027739169a 100644 --- a/docs/setup/settings.asciidoc +++ b/docs/setup/settings.asciidoc @@ -8,9 +8,10 @@ default it is in `$KIBANA_HOME/config`. By default, with package distributions (Debian or RPM), it is in `/etc/kibana`. The config directory can be changed via the `KBN_PATH_CONF` environment variable: -``` +[source,text] +-- KBN_PATH_CONF=/home/kibana/config ./bin/kibana -``` +-- The default host and port settings configure {kib} to run on `localhost:5601`. To change this behavior and allow remote users to connect, you'll need to update your `kibana.yml` file. You can also enable SSL and set a variety of other options. Finally, environment variables can be injected into @@ -281,7 +282,7 @@ To reload the logging settings, send a SIGHUP signal to {kib}. |=== |[[logging-root]] `logging.root:` -| The {kibana-ref}/logging-service.html#logging-service[`root` logger] has a dedicated configuration node since this context name is special and is pre-configured for logging by default. +| The {kibana-ref}/logging-service.html#logging-service[`root` logger] has a dedicated configuration node since this context name is special and is pre-configured for logging by default. // TODO: add link to the advanced logging documentation. |[[logging-root-appenders]] `logging.root.appenders:` @@ -313,7 +314,7 @@ To reload the logging settings, send a SIGHUP signal to {kib}. | Allows you to specify a fileName to send log records to on disk. To send <>, add the file appender to `root.appenders`. | `logging.appenders.rolling-file:` -| Similar to Log4j's `RollingFileAppender`, this appender will log into a file and rotate if following a rolling strategy when the configured policy triggers. There are currently two policies supported: `size-limit` and `time-interval`. +| Similar to Log4j's `RollingFileAppender`, this appender will log into a file and rotate if following a rolling strategy when the configured policy triggers. There are currently two policies supported: `size-limit` and `time-interval`. The size limit policy will perform a rollover when the log file reaches a maximum `size`. *Default 100mb* @@ -504,49 +505,39 @@ deprecation warning at startup. This setting cannot end in a slash (`/`). proxy sitting in front of it. This determines whether HTTP compression may be used for responses, based on the request `Referer` header. This setting may not be used when <> is set to `false`. *Default: `none`* - -a| [[server-securityResponseHeaders-strictTransportSecurity]] ----- -server.securityResponseHeaders: - strictTransportSecurity: ----- +[[server-securityResponseHeaders-strictTransportSecurity]] +a| +`server.securityResponseHeaders:` +`strictTransportSecurity:` | Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security[`Strict-Transport-Security`] header is used in all responses to the client from the {kib} server, and specifies what value is used. Allowed values are any text value or `null`. To disable, set to `null`. *Default:* `null` -a| [[server-securityResponseHeaders-xContentTypeOptions]] ----- -server.securityResponseHeaders: - xContentTypeOptions: ----- +[[server-securityResponseHeaders-xContentTypeOptions]] +a| `server.securityResponseHeaders:` +`xContentTypeOptions:` | Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options[`X-Content-Type-Options`] header is used in all responses to the client from the {kib} server, and specifies what value is used. Allowed values are `nosniff` or `null`. To disable, set to `null`. *Default:* `"nosniff"` -a| [[server-securityResponseHeaders-referrerPolicy]] ----- -server.securityResponseHeaders: - referrerPolicy: ----- +[[server-securityResponseHeaders-referrerPolicy]] +a|`server.securityResponseHeaders:` +`referrerPolicy:` | Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy[`Referrer-Policy`] header is used in all responses to the client from the {kib} server, and specifies what value is used. Allowed values are `no-referrer`, `no-referrer-when-downgrade`, `origin`, `origin-when-cross-origin`, `same-origin`, `strict-origin`, `strict-origin-when-cross-origin`, `unsafe-url`, or `null`. To disable, set to `null`. *Default:* `"no-referrer-when-downgrade"` -a| [[server-securityResponseHeaders-permissionsPolicy]] ----- -server.securityResponseHeaders: - permissionsPolicy: ----- +[[server-securityResponseHeaders-permissionsPolicy]] +a|`server.securityResponseHeaders:` +`permissionsPolicy:` | experimental[] Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Feature-Policy[`Permissions-Policy`] header is used in all responses to the client from the {kib} server, and specifies what value is used. Allowed values are any text value or `null`. To disable, set to `null`. *Default:* `null` -a| [[server-securityResponseHeaders-disableEmbedding]] ----- -server.securityResponseHeaders: - disableEmbedding: ----- +[[server-securityResponseHeaders-disableEmbedding]] +a|`server.securityResponseHeaders:` +`disableEmbedding:` | Controls whether the https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy[`Content-Security-Policy`] and https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options[`X-Frame-Options`] headers are configured to disable embedding {kib} in other webpages using iframes. When set to `true`, secure headers are used to disable embedding, which adds the `frame-ancestors: