diff --git a/doc/install.md b/doc/install.md index b2307e823318edb72d91505f5bba42098e247aad..1a1c1f3936508d2d1cb9e471255d867b5dc3d1e4 100644 --- a/doc/install.md +++ b/doc/install.md @@ -21,7 +21,7 @@ The current version of SOCTools only runs on a single server. A fully distribute * `cd soctools` To test the development version you can clone the repository instead of downloading the latest release: -* git clone https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git +* git clone --recursive https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git * `cd soctools` ## Configure SOCTools @@ -40,16 +40,13 @@ You can use configuration script named "configure.sh", located in the root folde * User Management UI - Web UI for creating and managing SOCTools users. Increase security by restricting access only for administrator(s) * Kibana - Web UI for Kibana. Increase security by restricting access only for administrator(s) -Edit roles/haproxy/files/stats_whitelist.lst in order to manually configure whitelist IP addresses for accessing various tools. You can use access.ips file found in the root folder as starting template. +Edit `roles/haproxy/files/stats_whitelist.lst` in order to manually configure whitelist IP addresses for accessing various tools. You can use `access.ips` file found in the root folder as a starting template. * `cat access.ips > roles/haproxy/files/stats_whitelist.lst` * `vi roles/haproxy/files/stats_whitelist.lst` -Edit group_vars/all/main.yml and change 'soctoolsproxy' so that it points to the FQDN of the server. +If you want to use MaxMind GeoLite2 database for enrichment, edit `group_vars/all/main.yml` and add the license key to the variable `maxmind_key`. * `vi group_vars/all/main.yml` -If you want to use MaxMind GeoLite2 database for enrichment, add the license key to the variable 'maxmind_key' -Users can be configured in the file group_vars/all/users.yml -* `vi group_vars/all/users.yml` ## Install SOCTools Configure the server running SOCTools: