Quick Setup Guide  #

Introduction  #

This guide is designed to provide a clear and detailed process to get started with MyOrbik. It serves as a centralized reference for configuring and running the project in a local Linux environment. Follow the steps below to set up MyOrbik quickly and effectively.

Environment Setup #

Required Tools  #

Ensure the following tools are installed on your system: 

• Docker 
• Node.js 
• Minikube 
• Helm 
• Kubectl 
• Go 

Installing the Required Tools  #

For each tool, follow the official documentation linked below: 

• Docker: 
  • Install Docker Engine 
  • Post-Installation Steps (optional for non-admin users) 
• Node.js: 
  • Install Node.js 
• Minikube: 
  • Install Minikube 
• Helm: 
  • Install Helm 
• Kubectl: 
  • Install Kubectl 
• Go: 
  • Install Go 
  • Simple Command: sudo snap install go –classic 

First-Time Setup #

Preparing the Minikube Environment  #

MyOrbik uses Kubernetes for deployment. For local execution, Minikube is required.
Run the following command to start Minikube with optimized resources: 

minikube start –memory=6144 –cpus=6 –kubernetes-version=v1.30.0   

Setting Up PostgreSQL  #

PostgreSQL serves as the main database for MyOrbik. 

1. Navigate to the helm folder. 
2. Run the PostgreSQL installer:

        helm/postgres/install_postgres.sh   

        3. Wait for the installation to complete. 

        4. Access PostgreSQL with the default credentials: 

• • User: postgres 
  • Password: postgres 

        5. Create the following databases for the postgres user: 

• • bitnami_keycloak: Manages SSO. 
  • dtrack: Manages vulnerability tracking. 
  • (Optional) bitnami_ejbca: Additional functionality. 

Setting Up Keycloak  #

Keycloak is used for identity and access management. 

1. Navigate to the helm folder. 
2. Run the Keycloak installer:

        helm/keycloak/install-keycloak.sh   

        3. Wait for the installation to complete. 

        4. Access Keycloak at http://localhost:8088 with default credentials: 

• • User: admin 
  • Password: admin 

         5. Import configurations: 

• • Realm: Import from helm/tools/realm-export.json. 
  • (Optional) Clients: Import myorbikBackend.json and swaggerOIDC.json. 

Setting Up Dependency-Track  #

Dependency-Track is used for vulnerability management. 

1. Access Dependency-Track at http://localhost:8880 with default credentials: 

• • User: admin 
  • Password: admin 
  • On first login, change the password (recommended: orbik). 

        2. Configure an API Key: 

• • Navigate to Administration -> Access Management -> Teams -> Create Team. 
  • Assign all permissions and create an API key. 
  • Use this key in the .env.local file for the portal/api service. 

        3. (Optional) Request an API Key from NIST. 

Running Remaining Services #

1. Navigate to the helm folder. 
2. Run the services launcher: 

        helm/tools/launcher.sh   

        3. Wait for the process to complete. 

Post-Configuration #

External Services Setup  #

1. Navigate to the api folder. 
2. Copy the .env file and create a duplicate named .env.local. 
3. Run the following debuggers: 

• • Launch EPSS 
  • Launch KEV 
  • Launch CPE 

        4. These debuggers download vulnerabilities and other resources for MyOrbik. 

• • Recommendation: Execute them once every two weeks.

Local Deployment #

After completing the initial setup, deploy MyOrbik locally. 

1. Navigate to the helm folder. 
2. Execute the launcher:

        helm/tools/launcher.sh   

        3. Wait for the process to finish. 

 By following this guide, you’ll have MyOrbik up and running in a local environment, ready to handle your security and compliance needs effectively. 

If you have any questions or need help setting up, please contact our Support Team.