You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: _install-and-configure/install-dashboards/debian.md
+70-21Lines changed: 70 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,120 +24,169 @@ This guide assumes that you are comfortable working from the Linux command line
24
24
## Installing OpenSearch Dashboards from a package
25
25
26
26
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.
1. After the installation completes, reload the systemd manager configuration.
34
+
{% include copy.html %}
35
+
36
+
1. After the installation completes, reload the systemd manager configuration:
35
37
```bash
36
38
sudo systemctl daemon-reload
37
39
```
38
-
1. Enable OpenSearch as a service.
40
+
{% include copy.html %}
41
+
42
+
1. Enable OpenSearch Dashboards as a service:
39
43
```bash
40
44
sudo systemctl enable opensearch-dashboards
41
45
```
42
-
1. Start the OpenSearch service.
46
+
{% include copy.html %}
47
+
48
+
1. Start the OpenSearch Dashboards service:
43
49
```bash
44
50
sudo systemctl start opensearch-dashboards
45
51
```
46
-
1. Verify that OpenSearch launched correctly.
52
+
{% include copy.html %}
53
+
54
+
1. Verify that OpenSearch Dashboards launched correctly:
47
55
```bash
48
56
sudo systemctl status opensearch-dashboards
49
57
```
58
+
{% include copy.html %}
50
59
51
60
### Fingerprint verification
52
61
53
62
The Debian package is not signed. If you would like to verify the fingerprint, the OpenSearch Project provides a `.sig` file as well as the `.deb` package for use with GNU Privacy Guard (GPG).
## Installing OpenSearch Dashboards from an APT repository
73
89
74
90
APT, the primary package management tool for Debian–based operating systems, allows you to download and install the Debian package from the APT repository.
1. Create an APT repository for OpenSearch Dashboards:
85
111
```bash
86
112
echo "deb [signed-by=/etc/apt/keyrings/opensearch-release-keyring] https://artifacts.opensearch.org/releases/bundle/opensearch-dashboards/{{major_version_mask}}/apt stable main" | sudo tee /etc/apt/sources.list.d/opensearch-dashboards-{{major_version_mask}}.list
87
113
```
88
-
1. Verify that the repository was created successfully.
114
+
{% include copy.html %}
115
+
116
+
1. Verify that the repository was created successfully:
89
117
```bash
90
118
sudo apt-get update
91
119
```
120
+
{% include copy.html %}
121
+
92
122
1. (Optional) As of May 22, 2024, the `Origin` and `Label` values of the APT repository were updated as part of [this change](https://github.com/opensearch-project/opensearch-build/issues/4485). If you created the APT repository before this date, run the following command to accept the updated release information:
93
123
```bash
94
124
sudo apt-get update --allow-releaseinfo-change
95
125
```
96
-
1. With the repository information added, list all available versions of OpenSearch:
126
+
{% include copy.html %}
127
+
128
+
1. With the repository information added, list all available versions of OpenSearch Dashboards:
97
129
```bash
98
130
sudo apt list -a opensearch-dashboards
99
131
```
100
-
1. Choose the version of OpenSearch you want to install:
101
-
- Unless otherwise indicated, the latest available version of OpenSearch is installed.
132
+
{% include copy.html %}
133
+
134
+
1. Choose the version of OpenSearch Dashboards you want to install:
135
+
- Unless otherwise indicated, the latest available version of OpenSearch Dashboards is installed.
102
136
```bash
103
137
sudo apt-get install opensearch-dashboards
104
138
```
139
+
{% include copy.html %}
140
+
105
141
- To install a specific version of OpenSearch Dashboards, pass a version number after the package name.
106
142
```bash
107
143
# Specify the version manually using opensearch=<version>
1. Verify that OpenSearch Dashboards launched correctly:
119
161
```bash
120
162
sudo systemctl status opensearch-dashboards
121
163
```
164
+
{% include copy.html %}
122
165
123
166
## Exploring OpenSearch Dashboards
124
167
125
168
By default, OpenSearch Dashboards, like OpenSearch, binds to `localhost` when you initially install it. As a result, OpenSearch Dashboards is not reachable from a remote host unless the configuration is updated.
126
169
127
-
1. Open `opensearch_dashboards.yml`.
170
+
1. Open `opensearch_dashboards.yml`:
128
171
```bash
129
172
sudo vi /etc/opensearch-dashboards/opensearch_dashboards.yml
130
173
```
131
-
1. Specify a network interface that OpenSearch Dashboards should bind to.
174
+
{% include copy.html %}
175
+
176
+
1. Specify a network interface that OpenSearch Dashboards should bind to:
132
177
```bash
133
178
# Use 0.0.0.0 to bind to any available interface.
134
179
server.host: 0.0.0.0
135
180
```
181
+
{% include copy.html %}
182
+
136
183
1. Save and quit.
137
-
1. Restart OpenSearch Dashboards to apply the configuration change.
184
+
1. Restart OpenSearch Dashboards to apply the configuration change:
138
185
```bash
139
186
sudo systemctl restart opensearch-dashboards
140
187
```
188
+
{% include copy.html %}
189
+
141
190
1. From a web browser, navigate to OpenSearch Dashboards. The default port is 5601.
142
191
1. Log in with the default username `admin` and the default password `admin`. (For OpenSearch 2.12 and later, the password should be the custom admin password)
143
192
1. Visit [Getting started with OpenSearch Dashboards]({{site.url}}{{site.baseurl}}/dashboards/index/) to learn more.
0 commit comments