diff --git a/quickstart.md b/quickstart.md deleted file mode 100644 index 9938303d8a291e192dd14de2739e985fa2b701c7..0000000000000000000000000000000000000000 --- a/quickstart.md +++ /dev/null @@ -1,68 +0,0 @@ -# Hardware and software requirements - -You need virtual machine with following minimal configuration: -* CPU: 8 cores -* Memory: 32GB -* Disk: 40GB - -Software requirements are following: -* Minimal installation of CentOS7 -* Set hostname for your Virtual Machine and create corresponding DNS record (will be needed later) -* Install Ansible - * `sudo yum -y install epel-release` - * `sudo yum -y install ansible git` - * `sudo ansible-galaxy collection install ansible.posix` - - -# Download SOCTools and prepare installation configuration - -Download the current version using: - -`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: - -`./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] - -# Install and try SOCTools - -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 buildimages.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: -* 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 - -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 init` - -After the whole process is finished, SOCTools can be accessed by going to https://<server name>:<port>/ using the following port numbers: - -* 9443 - NiFi -* 5601 - Kibana -* 6443 - Misp -* 9000 - The Hive -* 9001 - Cortex -* 12443 - Keycloak - - - - - -