Prerequisites for Docker

Operating system

For Docker-based installation, any Linux distribution with Docker support is required. Ensure that all necessary Docker dependencies are set up before proceeding with the installation. Further information on the compatibility of Docker CE and EE can be found on the Docker help center: https://docs.docker.com/install/overview/

Hardware

• We recommend a minimum of 2 dedicated cores
• For projects > 1 Mio. Lines of code 4 cores are recommended
• For projects > 3 Mio. Lines of code 8 cores are recommended.

Memory

• Minimum 8 GB RAM (dedicated)
• For projects > 1 Mio. Lines of code 16 GB RAM are recommended 
• For projects > 3 Mio. Lines of code 32 GB RAM are recommended.

Storage

• Minimum of 100 GB storage 
• Should be expandable to support a growing analysis history
• The table below gives an indication on the growing storage requirements:

Table 1:Storage estimations

Network

During Installation

• The instance needs to be accessible through SSH. 

After Installation

• One port needs to be exposed to access BrowserStack Code Quality via HTTP on the browser (by default port 3000)
• For remote scans where scans run on a build machine and results are published to the BrowserStack Code Quality server, port 5432 also needs to be exposed
• Connectivity to all external systems that should be integrated is required on the relevant ports-
  • This includes connectivity to the repositories (i.e. git, GitHub, GitLab, TFS, SVN) on the required ports (i.e. HTTPS, SSH)
  • If CI integration is required, connectivity between BrowserStack Code Quality on the CI system is required
  • If task management is required, connectivity between BrowserStack Code Quality and the task management system needs to be there (i.e. for Jira, Teamforge)