Skip to content
This repository was archived by the owner on Sep 20, 2023. It is now read-only.

Commit 8f7764b

Browse files
authored
Update install-guide.md
There a few issues which need to be addressed. The first being that the TOC is not up to date and several headings are not shown in the Table of Contents. I did not make that update. Another is the section titled First Start (line # 226 through #330): I made corrections to some of the text to help make the text easier to understand. However, after reading through the entire section it seems to be out of order. I would suggest further that the title be changed to something like "Launching the Application for the First Time" or "Initialize the Application"..... If you see as I do that this section and the guide in general is out of order. I would further suggest that you start with a Setup section.
1 parent 6941e3e commit 8f7764b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

installation/install-guide.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -221,12 +221,12 @@ unzip thehive-latest.zip
221221
ln -s thehive-x.x.x thehive
222222
```
223223

224-
**Note**: if you would like to use pre-release, beta versions of and help us find bugs to the benefit of the whole community, please download `https://dl.bintray.com/thehive-project/binary/thehive-version-RCx.zip`. For example `https://dl.bintray.com/thehive-project/binary/thehive-3.1.0-RC1.zip`.
224+
**Note**: If you would like to use pre-release, beta versions of and help us find bugs to the benefit of the whole community, please download `https://dl.bintray.com/thehive-project/binary/thehive-version-RCx.zip`. For example `https://dl.bintray.com/thehive-project/binary/thehive-3.1.0-RC1.zip`.
225225

226226
#### 5. First start
227-
It is recommended to use a dedicated, non-privileged user account to start TheHive. If so, make sure that the chosen account can create log files in `/opt/thehive/logs`.
228-
229-
If you'd rather start the application as a service, use the following commands:
227+
You may start the application by using creating a non-previlidged user account or starting the application as a service.
228+
If you choose to start the application by creating a non-previlidged user account ensure that it can create log files in `/opt/thehive/logs`.
229+
Or if you choose to start the application as a service, use the following commands:
230230

231231
```bash
232232
sudo addgroup thehive
@@ -239,8 +239,10 @@ sudo systemctl enable thehive
239239
sudo service thehive start
240240
```
241241

242-
The only required parameter in order to start TheHive is the key of the server (`play.http.secret.key`). This key is used
243-
to authenticate cookies that contain data. If TheHive runs in cluster mode, all instances must share the same key.
242+
To start TheHive you must use the secret key (`play.http.secret.key`), which is used
243+
to authenticate cookies that contain data.
244+
245+
Note: If you are running TheHive in the cluster mode, all instances must share the same key.
244246
You can generate the minimal configuration with the following commands (they assume that you have created a
245247
dedicated user for TheHive, named `thehive`):
246248

@@ -264,8 +266,6 @@ bin/thehive -Dconfig.file=/etc/thehive/application.conf
264266

265267
Please note that the service may take some time to start. Once it is started, you may launch your browser and connect to `http://YOUR_SERVER_ADDRESS:9000/`.
266268

267-
Please note that the service may take some time to start.
268-
269269
The first time you connect you will have to create the database schema. Click "Migrate database" to create the DB schema.
270270

271271
![](../images/thehive-first-access_screenshot.png)
@@ -279,7 +279,7 @@ Once created, you should be redirected to the login page.
279279
![](../images/thehive-login_page.png)
280280

281281
**Warning**: at this stage, if you missed the creation of the admin account, you will not be able to do it unless you
282-
delete TheHive's index from Elasticsearch. In the case you made a mistake, first find out what is the current index of TheHive by running the following command on a host where the Elasticsearch DB used by TheHive is located:
282+
delete TheHive's index from Elasticsearch. In case you made this mistake, first find out what is the current index of TheHive by running the following command on a host where the Elasticsearch DB used by TheHive is located:
283283

284284
```bash
285285
$ curl http://127.0.0.1:9200/_cat/indices?v

0 commit comments

Comments
 (0)