Skip to content

Commit 187b334

Browse files
authored
Update INSTALL.md
1 parent 3b6d6a4 commit 187b334

1 file changed

Lines changed: 30 additions & 28 deletions

File tree

INSTALL.md

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@ Diskover Community Edition can be installed on any Linux distribution that allow
2323

2424
## Elasticsearch 8.X Installation
2525

26-
🔴 Install the Java OpenJDK Packages:
26+
🔴 Install the Java OpenJDK packages:
2727

2828
```
2929
yum -y install java-21-openjdk
3030
```
3131

32-
🔴 Configure YUM Repository for ES 8:
32+
🔴 Configure YUM repository for ES 8:
3333

3434
```
3535
vi /etc/yum.repos.d/elasticsearch.repo
3636
```
3737

38-
🔴 *Add the following to the file and save it:*
38+
🔴 Add the following to the file and save it:
3939

4040
```sh
4141
[elasticsearch]
@@ -48,7 +48,7 @@ autorefresh=1
4848
type=rpm-md
4949
```
5050

51-
🔴 Install the Latest ES 8 Package:
51+
🔴 Install the latest ES 8 package:
5252

5353
```
5454
yum -y install --disablerepo="*" --enablerepo=elasticsearch elasticsearch
@@ -60,7 +60,7 @@ yum -y install --disablerepo="*" --enablerepo=elasticsearch elasticsearch
6060
vi /etc/elasticsearch/elasticsearch.yml
6161
```
6262

63-
🔴 *Ensure the following properties are set and uncommented:*
63+
🔴 Ensure the following properties are set and uncommented:
6464

6565
```sh
6666
cluster.name: <name of your cluster> (Should be a distinctive name)
@@ -75,20 +75,20 @@ xpack.security.enrollment.enabled: false (disable security enrollment on firs
7575
xpack.ml.enabled: false (disable machine learning functionality - not needed)
7676
```
7777

78-
🔴 ES Memory Lock:
78+
🔴 ES memory lock:
7979

8080
```
8181
vi /etc/elasticsearch/jvm.options
8282
```
8383

84-
🔴 *Ensure the JVM args are uncommented and set to 1/2 of your available RAM:*
84+
🔴 Ensure the JVM args are uncommented and set to 1/2 of your available RAM:
8585

8686
```sh
8787
-Xms32g
8888
-Xmx32g
8989
```
9090

91-
🔴 ES SystemD Service Memory Settings:
91+
🔴 ES SystemD Service memory settings:
9292

9393
```
9494
mkdir /etc/systemd/system/elasticsearch.service.d
@@ -98,7 +98,7 @@ mkdir /etc/systemd/system/elasticsearch.service.d
9898
vi /etc/systemd/system/elasticsearch.service.d/elasticsearch.conf
9999
```
100100

101-
🔴 *Add the following to the file and save it:*
101+
🔴 Add the following to the file and save it:
102102

103103
```sh
104104
[Service]
@@ -107,14 +107,14 @@ LimitNPROC=4096
107107
LimitNOFILE=65536
108108
```
109109

110-
🔴 Start and Enable the ES Service:
110+
🔴 Start and enable the ES service:
111111

112112
```sh
113113
systemctl enable elasticsearch
114114
systemctl start elasticsearch
115115
```
116116

117-
🔴 Check the ES Cluster Health:
117+
🔴 Check the ES cluster health:
118118

119119
```sh
120120
curl http://localhost:9200/_cluster/health?pretty
@@ -144,7 +144,7 @@ curl http://localhost:9200/_cluster/health?pretty
144144
yum -y install nginx
145145
```
146146

147-
🔴 Enable and start the Nginx Service:
147+
🔴 Enable and start the Nginx service:
148148

149149
```sh
150150
systemctl enable nginx
@@ -154,22 +154,22 @@ systemctl status nginx
154154

155155
## PHP Installation
156156

157-
🔴 Enable EPEL and REMI Repositories -- *change the 8s to 9s if using RHEL / Rocky Linux 9*:
157+
🔴 Enable EPEL and REMI repositories -- *change the 8s to 9s if using RHEL / Rocky Linux 9*:
158158

159159
```sh
160160
yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
161161
yum -y install https://rpms.remirepo.net/enterprise/remi-release-8.rpm
162162
```
163163

164-
🔴 Install PHP 8 Packages:
164+
🔴 Install PHP 8 packages:
165165

166166
```sh
167167
yum -y install php84 php84-php-common php84-php-fpm php84-php-opcache \
168168
php84-php-cli php84-php-gd php84-php-mysqlnd php84-php-ldap php84-php-pecl-zip \
169169
php84-php-xml php84-php-mbstring php84-php-json php84-php-sqlite3
170170
```
171171

172-
🔴 Copy in Production `php.ini`:
172+
🔴 Copy in production `php.ini`:
173173

174174
```sh
175175
cp /opt/remi/php84/root/usr/share/doc/php84-php-common/php.ini-production /etc/opt/remi/php84/php.ini
@@ -182,13 +182,13 @@ find / -mount -name php.ini
182182
-- /etc/opt/remi/php84/php.ini
183183
```
184184

185-
🔴 Edit PHP-FPM Configurations:
185+
🔴 Edit PHP-FPM configurations:
186186

187187
```
188188
vi /etc/opt/remi/php84/php-fpm.d/www.conf
189189
```
190190

191-
🔴 *Ensure the following properties are set and uncommented:*
191+
🔴 Ensure the following properties are set and uncommented:
192192

193193
```sh
194194
user = nginx (change user from 'apache')
@@ -199,20 +199,20 @@ listen.group = nginx (change user from 'nobody' a
199199
;listen.acl_users = apache (ensure this is commented out with the ;)
200200
```
201201

202-
🔴 PHP Directories Ownership:
202+
🔴 PHP directories ownership:
203203

204204
```sh
205205
chown -R root:nginx /var/opt/remi/php84/lib/php (this command may differ depending on your PHP8 install directory)
206206
mkdir /var/run/php-fpm
207207
chown -R nginx:nginx /var/run/php-fpm
208208
```
209209

210-
🔴 Create SystemD Service File:
210+
🔴 Create SystemD service file:
211211
```
212212
vi /etc/systemd/system/php-fpm.service
213213
```
214214

215-
🔴 *Add the following to the file and save it*:
215+
🔴 Add the following to the file and save it:
216216

217217
```sh
218218
[Unit]
@@ -228,7 +228,7 @@ Type=simple
228228
WantedBy=multi-user.target
229229
```
230230

231-
🔴 Set Permissions, Enable and Start the Service:
231+
🔴 Set permissions, enable and start the service:
232232

233233
```sh
234234
chmod 644 /etc/systemd/system/php-fpm.service
@@ -248,14 +248,14 @@ Diskover Community Edition v2.3 requires at a minimum Python3.8 to be installed
248248
yum -y install python3.12 python3.12-devel gcc
249249
```
250250

251-
🔴 Configure Python v3.12 for Usage - *There are a couple of options here*:
251+
🔴 Configure Python v3.12 for usage - there are a couple of options here:
252252

253-
- Call Python3.12 directly from Diskover and do nothing to the system level Python3 executable (Recommended).
254-
- Symlink Python3.12 in as the default Python3 executable on your OS.
253+
- Call Python3.12 directly from Diskover and do nothing to the system level **Python3 executable (Recommended)**.
254+
- **Symlink** Python3.12 in as the default Python3 executable on your OS.
255255

256256
### Diskover Python Executable
257257

258-
Using this approach we will simply execute Diskover with the full path to our Python3.12 version : `/usr/bin/python3.12`
258+
Using this approach, we will simply execute Diskover with the full path to our Python3.12 version : `/usr/bin/python3.12`
259259

260260
When we do a scan at the end of this install, we will use that full path instead of just `python3`
261261

@@ -290,14 +290,14 @@ cp -a diskover /opt/
290290
cp -a diskover-web /var/www/
291291
```
292292

293-
🔴 Install the Python Libraries:
293+
🔴 Install the Python libraries:
294294

295295
```sh
296296
/usr/bin/python3.12 -m ensurepip
297297
/usr/bin/python3.12 -m pip install -r /opt/diskover/requirements.txt
298298
```
299299

300-
🔴 Copy the Diskover-Web Nginx Configuration:
300+
🔴 Copy the Diskover-Web Nginx configuration:
301301

302302
```sh
303303
mv /var/www/diskover-web/diskover-web.conf /etc/nginx/conf.d/
@@ -334,7 +334,9 @@ The Community Edition doesn't require any license and it is free to use for an u
334334

335335
## Community Support
336336

337-
If you have any questions feel free to reach out on our Community Slack Organization - [Diskover Slack Workspace](https://join.slack.com/t/diskoverworkspace/shared_invite/zt-2up4tjux2-eZYt1OFgCeA3kSFQfsU93A)!
337+
If you have any questions feel free to reach out on our Community Slack Organization - [Diskover Slack Workspace](https://join.slack.com/t/diskoverworkspace/shared_invite/zt-2up4tjux2-eZYt1OFgCeA3kSFQfsU93A).
338+
339+
Please note that Diskover doesn't offer dedicated support for the free Community Edition.
338340

339341
## Feature Upgrade Information
340342

0 commit comments

Comments
 (0)