This is a docker-compose repository for a quick&easy start if you want to play around with the SecurityRAT tool (otherwise available at https://github.com/SecurityRAT/SecurityRAT).

Important: the setup is not suitable for a production environment!

Configuration

Configuration wise, nothing must be done since the application can be as well started with the default settings. The means that the following configurations are optional:

Database settings

1. First change the appropriate value in the mysql-service:

   environment: 
       MYSQL_DATABASE: # database name
       MYSQL\_ROOT\_PASSWORD: # the root password.
       MYSQL\_USER: # This user has full priviledge over the MYSQL\_DATABASE
       MYSQL\_PASSWORD: #Password of the MYSQL\_USER

2. Change the values in the securiryrat service to match does made above

   environment:
       - SPRING\_DATASOURCE\_URL=jdbc:mysql://mysql-service:3306/${MYSQL\_DATABASE}?useUnicode=true&characterEncoding=utf8&useSSL=false
       - SPRING\_DATASOURCE\_USERNAME=${MYSQL\_USER} 
       - SPRING\_DATASOURCE\_PASSWORD=${MYSQL\_PASSWORD}

How to run

1. Clone this project
2. Before running a new version of SecurityRAT, make sure you remove the old latest docker image. You can achieve this by running docker rmi securityrat/securityrat:latest. Alternatively, you could set the desired version of SecurityRAT you want to use by specifying the tag name in the docker-compose.yml file as follows:

   securityrat:
       container_name: securityrat 
       image: securityrat/securityrat:${image_tag_name}

3. Open a terminal and run docker-compose build from the project's root directory. This will build the latest mysql image which shall be used by the mysql-service.
4. Run docker-compose up --remove-orphans from the project's root directory.
5. After all services have started, navigate to https://localhost:9002 in your browser
6. Authenticate with one of the default users admin/admin or user/user
7. Optional: In order to play around with already existing data. We provide a list of requirements as SQL dump. This dump has already being copied to the mysql image built in step 2. To load this requirement into the database, open another terminal and run docker exec securityrat-mysql sh -c './var/dumpRequirements.sh'

Cleaning up

After stopping the app, run docker-compose down from the project's root directory to remove the created containers.