diff --git a/doc/quickstart.md b/doc/quickstart.md index 0abccab3a72020f20421eda76653a613c906ed5e..c5f794bf77d1d1fd3e16da5e03433477f301262b 100644 --- a/doc/quickstart.md +++ b/doc/quickstart.md @@ -18,7 +18,7 @@ Software requirements are following: Download the current version using: -`git clone https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git` +`git clone --recurse-submodules https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git` `cd soctools` @@ -26,26 +26,38 @@ The configuration script will guide you through the quick start process `./configure.sh` -First you need to fill in configuration file `access.ips`, which contains IP addresses and Networks that will be used to build access lists for services accessible from outside. +First you need to fill in configuration file `access.ips`, which contains IP addresses and Networks that will be used to build access lists for services accessible from outside. By default, all services except OPENSEARCH are public! - If you want to skip over access list creation process and use default access list, on "Do you want to modify/edit this file now?", press [Enter] or type no and press [Enter] -Next, we are going to set Fully Qualified Domain Name for your SOCTools server. +Next, we are going to set Fully Qualified Domain Name (FQDN) for your SOCTools server. Tools will be accessed by using https://[FQDN]:[port] - 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] We also need the name of your chosen domain in the last step. -- On "Organization's top level domain (will be used as organization name and organization domain in different services)", type the name of the domain used for hosting FQDN entered in the previous step and press [Enter] +- On "Name of your organization (it will be used as organization name in MISP, The Hive and Cortex)", type the name of your organization and press [Enter] -Following questions help us prepare your username and certificates that will be used to access various Tools in SOCTools. It also configures these parameters in `group_vars/all/variables.yml`. +Following questions help us prepare your username and certificates that will be used to access various Tools in SOCTools. It also configures these parameters in `group_vars/all/variables.yml`. You should enter only one user account, and create all other user accounts by using Web Management GUI. +- On "username:" type the username you want to use 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 "email:" type the email you will be using and press [Enter] + +Next few steps will help configure STMP account used by Web Management GUI to send information to newly created users. For testing purposes it may be left empty. We recommend using specifically made email address for this purpose. + +- On "host:" type the FQDN of your SMTP server and press [Enter] +- On "sender:" type type the email address that will be used as the sender and press [Enter] +- On "username:" type the user account (smtp username) and press [Enter] +- On "password:" type the password for the user account you will be using and press [Enter] + +After entering this information, you will be prompted if all of the entered information is correct: + - On "Correct? type 'yes' or 'no':", type yes and press [Enter] +**IMPORTANT:** If you enter 'no', the configuration will exit without making any changes, and you will have to start the process from the beginning. + After entering 'yes' and pressing [Enter], following files and folders will be modified: - `access.ips`