Skip to content

Commit b54d398

Browse files
Update deb/rpm install docs regarding DISABLE_INSTALL_DEMO_CONFIG, DISABLE_SECURITY_PLUGIN, DISABLE_SECURITY_DASHBOARDS_PLUGIN in 2.19.6
Signed-off-by: Peter Zhu <zhujiaxi@amazon.com>
1 parent 82316ff commit b54d398

4 files changed

Lines changed: 26 additions & 0 deletions

File tree

_install-and-configure/install-dashboards/debian.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ This guide assumes that you are comfortable working from the Linux command line
2626
# arm64
2727
sudo dpkg -i opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.deb
2828
```
29+
For new installations of OpenSearch Dashboards 2.19.6 and later, you can use the following environment variable to control the Security Dashboards plugin behavior:
30+
```bash
31+
DISABLE_SECURITY_DASHBOARDS_PLUGIN=true
32+
```
2933
1. After the installation completes, reload the systemd manager configuration.
3034
```bash
3135
sudo systemctl daemon-reload

_install-and-configure/install-dashboards/rpm.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ OpenSearch Dashboards is the default visualization tool for data in OpenSearch.
4040
# Install the arm64 package using rpm.
4141
sudo rpm -ivh opensearch-dashboards-{{site.opensearch_version}}-linux-arm64.rpm
4242
```
43+
For new installations of OpenSearch Dashboards 2.19.6 and later, you can use the following environment variable to control Security Dashboards plugin behavior:
44+
```bash
45+
DISABLE_SECURITY_DASHBOARDS_PLUGIN=true
46+
```
4347
1. After the installation succeeds, enable OpenSearch Dashboards as a service.
4448
```bash
4549
sudo systemctl enable opensearch-dashboards

_install-and-configure/install-opensearch/debian.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,15 @@ This guide assumes that you are comfortable working from the Linux command line
4040
1. Download the Debian package for the desired version directly from the [OpenSearch downloads page](https://opensearch.org/downloads.html){:target='\_blank'}. The Debian package can be downloaded for both **x64** and **arm64** architectures.
4141
1. From the CLI, install the package using `dpkg`:
4242

43+
For new installations of OpenSearch 2.19.6 and later, you can use the following installation-time environment variables to control the Security plugin behavior:
44+
* `DISABLE_INSTALL_DEMO_CONFIG=true` -- Prevents the installer from setting up demo security configuration (certificates, users, and roles). Use this for installations where you will configure security manually.
45+
* `DISABLE_SECURITY_PLUGIN=true` -- Disables the Security plugin entirely. Only use this for testing or development environments where security is not required.
46+
47+
To use these environment variables, add them before the installation command with the `env` keyword:
48+
```bash
49+
sudo env DISABLE_INSTALL_DEMO_CONFIG=true dpkg -i opensearch-{{site.opensearch_version}}-linux-x64.deb
50+
```
51+
4352
For new installations of OpenSearch 2.12 and later, you must define a custom admin password in order to set up a demo security configuration. Use one of the following commands to define a custom admin password:
4453
```bash
4554
# x64

_install-and-configure/install-opensearch/rpm.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,15 @@ This guide assumes that you are comfortable working from the Linux command line
4747

4848
1. From the CLI, you can install the package with `rpm` or `yum`:
4949

50+
For new installations of OpenSearch 2.19.6 and later, you can use the following installation-time environment variables to control the Security plugin behavior:
51+
* `DISABLE_INSTALL_DEMO_CONFIG=true` -- Prevents the installer from setting up demo security configuration (certificates, users, and roles). Use this for installations where you will configure security manually.
52+
* `DISABLE_SECURITY_PLUGIN=true` -- Disables the Security plugin entirely. Only use this for testing or development environments where security is not required.
53+
54+
To use these environment variables, add them before the installation command with the `env` keyword:
55+
```bash
56+
sudo env DISABLE_INSTALL_DEMO_CONFIG=true yum install opensearch-{{site.opensearch_version}}-linux-x64.rpm
57+
```
58+
5059
```bash
5160
# For new installations of OpenSearch 2.12 and later, you must define a custom admin password in order to set up a demo security configuration.
5261
# Use one of the following commands to define a custom admin password:

0 commit comments

Comments
 (0)