Skip to content

Commit 40d36db

Browse files
authored
Update INSTALL.md
1 parent 542b475 commit 40d36db

1 file changed

Lines changed: 92 additions & 57 deletions

File tree

INSTALL.md

Lines changed: 92 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,21 @@ git clone https://github.com/diskoverdata/diskover-community.git
2121

2222
Diskover Community Edition can be installed on any Linux distribution that allows the requirements to be installed properly. However, our team actively suggests any RHEL 8/9 or Rocky Linux 8/9 distributions!
2323

24-
## Elastic Search 8.X Installation
24+
## Elasticsearch 8.X Installation
2525

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

28-
`yum -y install java-21-openjdk`
28+
```
29+
yum -y install java-21-openjdk
30+
```
2931

30-
Configure YUM Repository for ES 8
32+
🔴 Configure YUM Repository for ES 8:
3133

32-
`vi /etc/yum.repos.d/elasticsearch.repo`
33-
-- *Add the following to the file and save it*
34+
```
35+
vi /etc/yum.repos.d/elasticsearch.repo
36+
```
37+
38+
🔴 *Add the following to the file and save it:*
3439

3540
```sh
3641
[elasticsearch]
@@ -43,14 +48,19 @@ autorefresh=1
4348
type=rpm-md
4449
```
4550

46-
Install the Latest ES 8 Package
51+
🔴 Install the Latest ES 8 Package:
4752

48-
`yum -y install --disablerepo="*" --enablerepo=elasticsearch elasticsearch`
53+
```
54+
yum -y install --disablerepo="*" --enablerepo=elasticsearch elasticsearch
55+
```
56+
57+
🔴 ES Setting Modifications
4958

50-
ES Setting Modifications
59+
```
60+
vi /etc/elasticsearch/elasticsearch.yml
61+
```
5162

52-
`vi /etc/elasticsearch/elasticsearch.yml`
53-
-- *Please ensure the following properties are set and uncommented*
63+
🔴 *Ensure the following properties are set and uncommented:*
5464

5565
```sh
5666
cluster.name: <name of your cluster> (Should be a distinctive name)
@@ -65,21 +75,30 @@ xpack.security.enrollment.enabled: false (disable security enrollment on firs
6575
xpack.ml.enabled: false (disable machine learning functionality - not needed)
6676
```
6777

68-
ES Memory Lock
78+
🔴 ES Memory Lock:
6979

70-
`vi /etc/elasticsearch/jvm.options`
71-
-- *Ensure the JVM args are uncommented and set to 1/2 of your available RAM*
80+
```
81+
vi /etc/elasticsearch/jvm.options
82+
```
83+
84+
🔴 *Ensure the JVM args are uncommented and set to 1/2 of your available RAM:*
7285

7386
```sh
7487
-Xms32g
7588
-Xmx32g
7689
```
7790

78-
ES SystemD Service Memory Settings
91+
🔴 ES SystemD Service Memory Settings:
92+
93+
```
94+
mkdir /etc/systemd/system/elasticsearch.service.d
95+
```
96+
97+
```
98+
vi /etc/systemd/system/elasticsearch.service.d/elasticsearch.conf
99+
```
79100

80-
`mkdir /etc/systemd/system/elasticsearch.service.d`
81-
`vi /etc/systemd/system/elasticsearch.service.d/elasticsearch.conf`
82-
-- *Add the following to the file and save it*
101+
🔴 *Add the following to the file and save it:*
83102

84103
```sh
85104
[Service]
@@ -88,14 +107,14 @@ LimitNPROC=4096
88107
LimitNOFILE=65536
89108
```
90109

91-
Start and Enable the ES Service
110+
🔴 Start and Enable the ES Service:
92111

93112
```sh
94113
systemctl enable elasticsearch
95114
systemctl start elasticsearch
96115
```
97116

98-
Check the ES Cluster Health
117+
🔴 Check the ES Cluster Health:
99118

100119
```sh
101120
curl http://localhost:9200/_cluster/health?pretty
@@ -120,11 +139,12 @@ curl http://localhost:9200/_cluster/health?pretty
120139

121140
## Nginx Installation
122141

123-
Install Nginx
124-
125-
`yum -y install nginx`
142+
🔴 Install Nginx:
143+
```
144+
yum -y install nginx
145+
```
126146

127-
Enable and Start the Nginx Service
147+
🔴 Enable and start the Nginx Service:
128148

129149
```sh
130150
systemctl enable nginx
@@ -134,22 +154,22 @@ systemctl status nginx
134154

135155
## PHP Installation
136156

137-
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*:
138158

139159
```sh
140160
yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
141161
yum -y install https://rpms.remirepo.net/enterprise/remi-release-8.rpm
142162
```
143163

144-
Install PHP 8 Packages
164+
🔴 Install PHP 8 Packages:
145165

146166
```sh
147167
yum -y install php84 php84-php-common php84-php-fpm php84-php-opcache \
148168
php84-php-cli php84-php-gd php84-php-mysqlnd php84-php-ldap php84-php-pecl-zip \
149169
php84-php-xml php84-php-mbstring php84-php-json php84-php-sqlite3
150170
```
151171

152-
Copy in Production php.ini
172+
🔴 Copy in Production `php.ini`:
153173

154174
```sh
155175
cp /opt/remi/php84/root/usr/share/doc/php84-php-common/php.ini-production /etc/opt/remi/php84/php.ini
@@ -162,10 +182,13 @@ find / -mount -name php.ini
162182
-- /etc/opt/remi/php84/php.ini
163183
```
164184

165-
Edit PHP-FPM Configurations
185+
🔴 Edit PHP-FPM Configurations:
166186

167-
`vi /etc/opt/remi/php84/php-fpm.d/www.conf`
168-
-- *Please ensure the following properties are set and uncommented*
187+
```
188+
vi /etc/opt/remi/php84/php-fpm.d/www.conf
189+
```
190+
191+
🔴 *Ensure the following properties are set and uncommented:*
169192

170193
```sh
171194
user = nginx (change user from 'apache')
@@ -176,17 +199,20 @@ listen.group = nginx (change user from 'nobody' a
176199
;listen.acl_users = apache (ensure this is commented out with the ;)
177200
```
178201

179-
PHP Directories Ownership
202+
🔴 PHP Directories Ownership:
180203

181204
```sh
182205
chown -R root:nginx /var/opt/remi/php84/lib/php (this command may differ depending on your PHP8 install directory)
183206
mkdir /var/run/php-fpm
184207
chown -R nginx:nginx /var/run/php-fpm
185208
```
186209

187-
Create SystemD Service File
188-
`vi /etc/systemd/system/php-fpm.service`
189-
-- *Add the following to the file and save it*
210+
🔴 Create SystemD Service File:
211+
```
212+
vi /etc/systemd/system/php-fpm.service
213+
```
214+
215+
🔴 *Add the following to the file and save it*:
190216

191217
```sh
192218
[Unit]
@@ -202,7 +228,7 @@ Type=simple
202228
WantedBy=multi-user.target
203229
```
204230

205-
Set Permissions, Enable and Start the Service
231+
🔴 Set Permissions, Enable and Start the Service:
206232

207233
```sh
208234
chmod 644 /etc/systemd/system/php-fpm.service
@@ -216,15 +242,16 @@ systemctl status php-fpm
216242

217243
Diskover Community Edition v2.3 requires at a minimum Python3.8 to be installed on the system. You can validate the Python3 version that was installed on your OS by default by running : `python3 -V` -- If this returns a version equal to or higher than 3.8, you can skip this section!
218244

219-
Install Python v3.12
245+
🔴 Install Python v3.12:
220246

221-
`yum -y install python3.12 python3.12-devel gcc`
247+
```
248+
yum -y install python3.12 python3.12-devel gcc
249+
```
222250

223-
Configure Python v3.12 for Usage
224-
-- *There are a couple of options here*
251+
🔴 Configure Python v3.12 for Usage - *There are a couple of options here*:
225252

226-
- Call Python3.12 directly from Diskover and do nothing to the system level Python3 executable (Recommended)
227-
- 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.
228255

229256
### Diskover Python Executable
230257

@@ -243,32 +270,34 @@ python3 -V
243270

244271
The output of your `python3 -V` command should show a 3.12.X
245272

246-
> **WARNING** - Depending on your distributtion and version of Linux, modifying the system level Python3 executable version could have unintended consequences..
273+
⚠️ **WARNING** Depending on your distributtion and version of Linux, modifying the system level Python3 executable version could have unintended consequences.
247274

248275
## Diskover Installation
249276

250-
Now that we've settled all the requirements to run the Diskover Community Edition.. Let's put the actual software in place. You'll want to get the code from this repository on the server you've been working on. Either by cloning this Git Repo directly on the server or pulling from our [Releases](https://github.com/diskoverdata/diskover-community/releases) page!
277+
Now that we've settled all the requirements to run the Diskover Community Edition, let's put the actual software in place. You'll want to get the code from this repository on the server you've been working on. Either by cloning this Git Repo directly on the server or pulling from our [Releases](https://github.com/diskoverdata/diskover-community/releases) page!
251278

252-
Uncompress the TAR
279+
🔴 Uncompress the TAR:
253280

254-
`tar -xvzf diskover-community-2.3.0.tar.gz`
281+
```
282+
tar -xvzf diskover-community-2.3.0.tar.gz
283+
```
255284

256-
Move the Source Code
285+
🔴 Move the Source Code:
257286

258287
```sh
259288
cd diskover-community-2.3.0/
260289
cp -a diskover /opt/
261290
cp -a diskover-web /var/www/
262291
```
263292

264-
Install the Python Libraries
293+
🔴 Install the Python Libraries:
265294

266295
```sh
267296
/usr/bin/python3.12 -m ensurepip
268297
/usr/bin/python3.12 -m pip install -r /opt/diskover/requirements.txt
269298
```
270299

271-
Copy the Diskover-Web Nginx Configuration
300+
🔴 Copy the Diskover-Web Nginx Configuration:
272301

273302
```sh
274303
mv /var/www/diskover-web/diskover-web.conf /etc/nginx/conf.d/
@@ -277,22 +306,28 @@ systemctl status nginx php-fpm
277306
chown -R nginx.nginx /var/www/diskover-web/
278307
```
279308

280-
> **NOTE** - You should now be able to hit your Diskover system at the IP address in the browser : `http://IP:8000` if this does not work initially and you get a 500 error, re-run that `chown` command above!
309+
✏️ **NOTE** You should now be able to hit your Diskover system at the IP address in the browser : `http://IP:8000` if this does not work initially and you get a 500 error, re-run that `chown` command above!
281310

282-
Execute a Scan Task
311+
## Execute a Scan Task
283312

284-
We have installed all of the necessary components for Diskover Community Edition. Let's run a scan of a folder on our local system and ensure things are working properly!
313+
We have installed all of the necessary components for Diskover Community Edition.
285314

286-
`/usr/bin/python3.12 /opt/diskover/diskover.py -i diskover-test /opt/diskover`
315+
🔴 Let's run a scan of a folder on our local system and ensure things are working properly:
287316

288-
Now that your scan has completed.. Let's view the contents!
317+
```
318+
/usr/bin/python3.12 /opt/diskover/diskover.py -i diskover-test /opt/diskover
319+
```
320+
321+
🔴 Now that your scan has completed.. Let's view the contents!
289322

290323
- Go Back to Diskover Web `http://IP:8000`
291-
- Click the **Settings** Icon in the Top-Right Corner
292-
- Choose `Indices`
324+
- Click the **⚙️ Settings** Icon in the Top-Right Corner
325+
- Choose **Indices**
293326
- Select the `diskover-test` Index and Choose `Save Selection`
294-
- Click the **Dashboard** or **File Search** Icon in the Top-Left Corner
327+
- Click the **Dashboard** or **📁 File Search** Icon in the Top-Left Corner
295328

296329
You've now successfully installed the Diskover Community Edition v2.3.X!
297330

298-
If you have any questions feel free to reach out on our Community Slack Organization here : [Diskover Slack Workspace](https://join.slack.com/t/diskoverworkspace/shared_invite/zt-2up4tjux2-eZYt1OFgCeA3kSFQfsU93A)!
331+
## Community Support
332+
333+
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)!

0 commit comments

Comments
 (0)