Skip to content
Snippets Groups Projects
Commit e44924db authored by Kiril KJiroski's avatar Kiril KJiroski
Browse files

Update quickstart.md

parent 215a7d06
No related branches found
No related tags found
1 merge request!4Quick start
...@@ -16,46 +16,50 @@ Software requirements are following: ...@@ -16,46 +16,50 @@ Software requirements are following:
# Download SOCTools and prepare installation configuration # Download SOCTools and prepare installation configuration
`git clone https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git` Download the current version using:
`cd soctools`
`git clone https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git`
`cd soctools`
First you need to fill in quick configuration files: First you need to fill in quick configuration files:
`./configure.sh` `./configure.sh`
On "Do you want to modify/edit this file now?", press [Enter] or type no and press [Enter]
On "set FQDN which will be used to access the soctools services. (the DNS record should already be in place.)" you should already have set up hostname and DNS record, so type it here and press [Enter]
On "Organization's top level domain (will be used as organization name and organization domain in different services)" you can use the part after the first "." in your DNS record. Type it and press [Enter]
On "firstame:" type your name and press [Enter]
On "lastname:" type your surname and press [Enter]
On "username:" type the username you want to use and press [Enter]
On "Enter CN for Certificate [username]:" press [Enter]
On "Correct? type 'yes' or 'no':", type yes and press [Enter]
* On "Do you want to modify/edit this file now?", press [Enter] or type no and press [Enter]
* On "set FQDN which will be used to access the soctools services. (the DNS record should already be in place.)" you should already have set up hostname and DNS record, so type it here and press [Enter]
* On "Organization's top level domain (will be used as organization name and organization domain in different services)" you can use the part after the first "." in your DNS record. Type it and press [Enter]
* On "firstame:" type your name and press [Enter]
* On "lastname:" type your surname and press [Enter]
* On "username:" type the username you want to use and press [Enter]
* On "Enter CN for Certificate [username]:" press [Enter]
* On "Correct? type 'yes' or 'no':", type yes and press [Enter]
# Install and try SOCTools # Install and try SOCTools
Following commands will let you configure the host, build docker images and build CA for service and user certificates: Following commands will let you configure the host, build docker images and build CA for service and user certificates:
`ansible-playbook -i inventories soctools_server.yml` * `ansible-playbook -i inventories soctools_server.yml`
`ansible-playbook -i inventories buildimages.yml` * `ansible-playbook -i inventories buildimages.yml`
`ansible-playbook -i inventories buildca.yml` * `ansible-playbook -i inventories buildca.yml`
This playbook will generate some errors but this is normal as long as the playbook ignores them and finish without stopping. After the last step you can download and install certificates, doing following steps: This playbook will generate some errors but this is normal as long as the playbook ignores them and finish without stopping. After the last step you can download and install certificates, doing following steps:
Download and import the root certificate located in secrets/CA/ca.crt (On windows the CA certificate should be installed in the Trusted Root Certficiation Authorities store) * Download and import the root certificate located in secrets/CA/ca.crt (On windows the CA certificate should be installed in the Trusted Root Certficiation Authorities store)
Download and import in the browseer user certificate (for the user you have created) found in the directory secrets/certificates. To import user certificate, you will need password find in the directory secrets/passwords * Download and import in the browseer user certificate (for the user you have created) found in the directory secrets/certificates. To import user certificate, you will need password find in the directory secrets/passwords
At last you can start SOCTools containers and initialize them using you configuration: At last you can start SOCTools containers and initialize them using you configuration:
`ansible-playbook -i inventories soctools.yml -t start-docker-containers` * `ansible-playbook -i inventories soctools.yml -t start-docker-containers`
`ansible-playbook -i inventories soctools.yml -t init` * `ansible-playbook -i inventories soctools.yml -t init`
After the whole process is finished, SOCTools can be accessed by going to https://<server name>:<port>/ using the following port numbers: After the whole process is finished, SOCTools can be accessed by going to https://<server name>:<port>/ using the following port numbers:
9443 - NiFi * 9443 - NiFi
5601 - Kibana * 5601 - Kibana
6443 - Misp * 6443 - Misp
9000 - The Hive * 9000 - The Hive
9001 - Cortex * 9001 - Cortex
12443 - Keycloak * 12443 - Keycloak
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment