Getting Started

Welcome to CyberOrigen! This guide will help you get up and running with our AI-powered security and compliance platform.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 20+ (via nvm)
• Python 3.12+
• Docker & Docker Compose
• Git

Installation

1. Clone the Repository

git clone https://github.com/your-org/cyberorigen.git
cd cyberorigen

2. Start Infrastructure Services

The platform uses Docker Compose for local development:

cd infrastructure
docker-compose up -d

This starts:

• PostgreSQL database
• Redis cache
• Backend API
• Worker processes

Verify services are running:

docker ps --format "table {{.Names}}\t{{.Status}}"

3. Start the Admin Portal

cd ../ui_cyberorigen
npm install
npm run dev

The Admin Portal will be available in your browser.

4. (Optional) Start Marketing Website

cd ..  # project root
npm install
npm run dev

Environment Configuration

Create a .env file in the backend/ directory with the required configuration:

• Database connection settings
• Authentication secrets
• AI provider API keys (Anthropic, OpenAI, or Google)
• Email service configuration

See backend/.env.example for all available options and their formats.

First Login

1. Navigate to the Admin Portal
2. Create your admin account during initial setup
3. You'll be prompted to set up MFA on first login

TIP

The first user to register becomes the organization admin.

Next Steps

• Architecture Overview - Understand system design
• GRC Dashboard - Explore compliance features
• Vulnerability Scanning - Set up security scans
• API Reference - Integrate with the API

Troubleshooting

Port Already in Use

# Find and kill process using a port
lsof -ti:<port> | xargs -r kill -9

Docker Container Issues

# View logs
docker logs <container-name>

# Restart services
docker-compose restart

Database Connection Issues

# Check PostgreSQL is running
docker ps | grep postgres

# Reset database (WARNING: deletes all data)
docker-compose down -v
docker-compose up -d

Getting Help

• Documentation: Browse the sidebar
• API Docs: API Reference
• Support: support@cyberorigen.com
• Security Issues: security@cyberorigen.com