diff --git a/doc/install.md b/doc/install.md index d48ef0bef486609464703d962cd3b29f2c12db9c..9cda041e7a68a3c5fcdd63936b5a22b8cf908d93 100644 --- a/doc/install.md +++ b/doc/install.md @@ -24,7 +24,17 @@ To test the development version you can clone the repository instead of download * git clone https://gitlab.geant.org/gn4-3-wp8-t3.1-soc/soctools.git * `cd soctools` -## Install SOCTools +## Configure SOCTools +You can use configuration script named "configure.sh", located in the root folder, in order to use the Configuration Wizzard and more easily enter preferred values for a number of options. This script will help you in following: +* Create whitelist for use with haproxy, in order to enable access to various tools from certain IP addresses. +* By default, following services are accessible only from internal docker network (172.22.0.0/16): +** HAProxy Stats - Statistics about proxied services/tools and their availability. Generally, you want only a selected number of people to be able to view them. + + +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. +* `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. * `vi group_vars/all/main.yml` @@ -32,6 +42,7 @@ If you want to use MaxMind GeoLite2 database for enrichment, add the license 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: * `ansible-playbook -i inventories soctools_server.yml`