|
| 1 | +--- |
| 2 | +# Copyright OpenSearch Contributors |
| 3 | +# SPDX-License-Identifier: Apache-2.0 |
| 4 | + |
| 5 | +# Description: |
| 6 | +# Default configuration for OpenSearch Dashboards |
| 7 | + |
| 8 | +# OpenSearch Dashboards is served by a back end server. This setting specifies the port to use. |
| 9 | +# server.port: 5601 |
| 10 | + |
| 11 | +# Specifies the address to which the OpenSearch Dashboards server will bind. IP addresses and host names are both valid values. |
| 12 | +# The default is 'localhost', which usually means remote machines will not be able to connect. |
| 13 | +# To allow connections from remote users, set this parameter to a non-loopback address. |
| 14 | +# server.host: "localhost" |
| 15 | + |
| 16 | +# Enables you to specify a path to mount OpenSearch Dashboards at if you are running behind a proxy. |
| 17 | +# Use the `server.rewriteBasePath` setting to tell OpenSearch Dashboards if it should remove the basePath |
| 18 | +# from requests it receives, and to prevent a deprecation warning at startup. |
| 19 | +# This setting cannot end in a slash. |
| 20 | +# server.basePath: "" |
| 21 | + |
| 22 | +# Specifies whether OpenSearch Dashboards should rewrite requests that are prefixed with |
| 23 | +# `server.basePath` or require that they are rewritten by your reverse proxy. |
| 24 | +# server.rewriteBasePath: false |
| 25 | + |
| 26 | +# The maximum payload size in bytes for incoming server requests. |
| 27 | +# server.maxPayloadBytes: 1048576 |
| 28 | + |
| 29 | +# The OpenSearch Dashboards server's name. This is used for display purposes. |
| 30 | +# server.name: "your-hostname" |
| 31 | + |
| 32 | +# The URLs of the OpenSearch instances to use for all your queries. |
| 33 | +# opensearch.hosts: ["http://localhost:9200"] |
| 34 | + |
| 35 | +# OpenSearch Dashboards uses an index in OpenSearch to store saved searches, visualizations and |
| 36 | +# dashboards. OpenSearch Dashboards creates a new index if the index doesn't already exist. |
| 37 | +# opensearchDashboards.index: ".opensearch_dashboards" |
| 38 | + |
| 39 | +# The default application to load. |
| 40 | +# opensearchDashboards.defaultAppId: "home" |
| 41 | + |
| 42 | +# Setting for an optimized healthcheck that only uses the local OpenSearch node to do Dashboards healthcheck. |
| 43 | +# This settings should be used for large clusters or for clusters with ingest heavy nodes. |
| 44 | +# It allows Dashboards to only healthcheck using the local OpenSearch node rather than fan out requests across all nodes. |
| 45 | +# |
| 46 | +# It requires the user to create an OpenSearch node attribute with the same name as the value used in the setting |
| 47 | +# This node attribute should assign all nodes of the same cluster an integer value that increments with each new cluster that is spun up |
| 48 | +# e.g. in opensearch.yml file you would set the value to a setting using node.attr.cluster_id: |
| 49 | +# Should only be enabled if there is a corresponding node attribute created in your OpenSearch config that matches the value here |
| 50 | +# opensearch.optimizedHealthcheckId: "cluster_id" |
| 51 | + |
| 52 | +# If your OpenSearch is protected with basic authentication, these settings provide |
| 53 | +# the username and password that the OpenSearch Dashboards server uses to perform maintenance on the OpenSearch Dashboards |
| 54 | +# index at startup. Your OpenSearch Dashboards users still need to authenticate with OpenSearch, which |
| 55 | +# is proxied through the OpenSearch Dashboards server. |
| 56 | +# opensearch.username: "opensearch_dashboards_system" |
| 57 | +# opensearch.password: "pass" |
| 58 | + |
| 59 | +# Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively. |
| 60 | +# These settings enable SSL for outgoing requests from the OpenSearch Dashboards server to the browser. |
| 61 | +# server.ssl.enabled: false |
| 62 | +# server.ssl.certificate: /path/to/your/server.crt |
| 63 | +# server.ssl.key: /path/to/your/server.key |
| 64 | + |
| 65 | +# Optional settings that provide the paths to the PEM-format SSL certificate and key files. |
| 66 | +# These files are used to verify the identity of OpenSearch Dashboards to OpenSearch and are required when |
| 67 | +# xpack.security.http.ssl.client_authentication in OpenSearch is set to required. |
| 68 | +# opensearch.ssl.certificate: /path/to/your/client.crt |
| 69 | +# opensearch.ssl.key: /path/to/your/client.key |
| 70 | + |
| 71 | +# Optional setting that enables you to specify a path to the PEM file for the certificate |
| 72 | +# authority for your OpenSearch instance. |
| 73 | +# opensearch.ssl.certificateAuthorities: [ "/path/to/your/CA.pem" ] |
| 74 | + |
| 75 | +# To disregard the validity of SSL certificates, change this setting's value to 'none'. |
| 76 | +# opensearch.ssl.verificationMode: full |
| 77 | + |
| 78 | +# Time in milliseconds to wait for OpenSearch to respond to pings. Defaults to the value of |
| 79 | +# the opensearch.requestTimeout setting. |
| 80 | +# opensearch.pingTimeout: 1500 |
| 81 | + |
| 82 | +# Time in milliseconds to wait for responses from the back end or OpenSearch. This value |
| 83 | +# must be a positive integer. |
| 84 | +# opensearch.requestTimeout: 30000 |
| 85 | + |
| 86 | +# List of OpenSearch Dashboards client-side headers to send to OpenSearch. To send *no* client-side |
| 87 | +# headers, set this value to [] (an empty list). |
| 88 | +# opensearch.requestHeadersWhitelist: [ authorization ] |
| 89 | + |
| 90 | +# Header names and values that are sent to OpenSearch. Any custom headers cannot be overwritten |
| 91 | +# by client-side headers, regardless of the opensearch.requestHeadersWhitelist configuration. |
| 92 | +# opensearch.customHeaders: {} |
| 93 | + |
| 94 | +# Time in milliseconds for OpenSearch to wait for responses from shards. Set to 0 to disable. |
| 95 | +# opensearch.shardTimeout: 30000 |
| 96 | + |
| 97 | +# Logs queries sent to OpenSearch. Requires logging.verbose set to true. |
| 98 | +# opensearch.logQueries: false |
| 99 | + |
| 100 | +# Specifies the path where OpenSearch Dashboards creates the process ID file. |
| 101 | +# pid.file: /var/run/opensearchDashboards.pid |
| 102 | + |
| 103 | +# Enables you to specify a file where OpenSearch Dashboards stores log output. |
| 104 | +# logging.dest: stdout |
| 105 | + |
| 106 | +# Set the value of this setting to true to suppress all logging output. |
| 107 | +# logging.silent: false |
| 108 | + |
| 109 | +# Set the value of this setting to true to suppress all logging output other than error messages. |
| 110 | +# logging.quiet: false |
| 111 | + |
| 112 | +# Set the value of this setting to true to log all events, including system usage information |
| 113 | +# and all requests. |
| 114 | +# logging.verbose: false |
| 115 | + |
| 116 | +# Set the interval in milliseconds to sample system and process performance |
| 117 | +# metrics. Minimum is 100ms. Defaults to 5000. |
| 118 | +# ops.interval: 5000 |
| 119 | + |
| 120 | +# Specifies locale to be used for all localizable strings, dates and number formats. |
| 121 | +# Supported languages are the following: English - en , by default , Chinese - zh-CN . |
| 122 | +# i18n.locale: "en" |
| 123 | + |
| 124 | +# Set the allowlist to check input graphite Url. Allowlist is the default check list. |
| 125 | +# vis_type_timeline.graphiteAllowedUrls: ['https://www.hostedgraphite.com/UID/ACCESS_KEY/graphite'] |
| 126 | + |
| 127 | +# Set the blocklist to check input graphite Url. Blocklist is an IP list. |
| 128 | +# Below is an example for reference |
| 129 | +# vis_type_timeline.graphiteBlockedIPs: [ |
| 130 | +# //Loopback |
| 131 | +# '127.0.0.0/8', |
| 132 | +# '::1/128', |
| 133 | +# //Link-local Address for IPv6 |
| 134 | +# 'fe80::/10', |
| 135 | +# //Private IP address for IPv4 |
| 136 | +# '10.0.0.0/8', |
| 137 | +# '172.16.0.0/12', |
| 138 | +# '192.168.0.0/16', |
| 139 | +# //Unique local address (ULA) |
| 140 | +# 'fc00::/7', |
| 141 | +# //Reserved IP address |
| 142 | +# '0.0.0.0/8', |
| 143 | +# '100.64.0.0/10', |
| 144 | +# '192.0.0.0/24', |
| 145 | +# '192.0.2.0/24', |
| 146 | +# '198.18.0.0/15', |
| 147 | +# '192.88.99.0/24', |
| 148 | +# '198.51.100.0/24', |
| 149 | +# '203.0.113.0/24', |
| 150 | +# '224.0.0.0/4', |
| 151 | +# '240.0.0.0/4', |
| 152 | +# '255.255.255.255/32', |
| 153 | +# '::/128', |
| 154 | +# '2001:db8::/32', |
| 155 | +# 'ff00::/8', |
| 156 | +# ] |
| 157 | +# vis_type_timeline.graphiteBlockedIPs: [] |
| 158 | + |
| 159 | +# opensearchDashboards.branding: |
| 160 | +# logo: |
| 161 | +# defaultUrl: "" |
| 162 | +# darkModeUrl: "" |
| 163 | +# mark: |
| 164 | +# defaultUrl: "" |
| 165 | +# darkModeUrl: "" |
| 166 | +# loadingLogo: |
| 167 | +# defaultUrl: "" |
| 168 | +# darkModeUrl: "" |
| 169 | +# faviconUrl: "" |
| 170 | +# applicationTitle: "" |
| 171 | + |
| 172 | +# Set the value of this setting to true to capture region blocked warnings and errors |
| 173 | +# for your map rendering services. |
| 174 | +# map.showRegionBlockedWarning: false% |
| 175 | + |
| 176 | +# Set the value of this setting to false to suppress search usage telemetry |
| 177 | +# for reducing the load of OpenSearch cluster. |
| 178 | +# data.search.usageTelemetry.enabled: false |
| 179 | + |
| 180 | +# 2.4 renames 'wizard.enabled: false' to 'vis_builder.enabled: false' |
| 181 | +# Set the value of this setting to false to disable VisBuilder |
| 182 | +# functionality in Visualization. |
| 183 | +# vis_builder.enabled: false |
| 184 | + |
| 185 | +# 2.4 New Experimental Feature |
| 186 | +# Set the value of this setting to true to enable the experimental multiple data source |
| 187 | +# support feature. Use with caution. |
| 188 | +# data_source.enabled: false |
| 189 | +# Set the value of these settings to customize crypto materials to encryption saved credentials |
| 190 | +# in data sources. |
| 191 | +# data_source.encryption.wrappingKeyName: 'changeme' |
| 192 | +# data_source.encryption.wrappingKeyNamespace: 'changeme' |
| 193 | +# data_source.encryption.wrappingKey: [0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0] |
| 194 | + |
| 195 | +opensearch.hosts: [https://localhost:9200] |
| 196 | +opensearch.ssl.verificationMode: none |
| 197 | +opensearch.username: kibanaserver |
| 198 | +opensearch.password: kibanaserver |
| 199 | +opensearch.requestHeadersWhitelist: [authorization, securitytenant] |
| 200 | + |
| 201 | +opensearch_security.multitenancy.enabled: true |
| 202 | +opensearch_security.multitenancy.tenants.preferred: [Private, Global] |
| 203 | +opensearch_security.readonly_mode.roles: [kibana_read_only] |
| 204 | +# Use this setting if you are running opensearch-dashboards without https |
| 205 | +opensearch_security.cookie.secure: false |
0 commit comments