Getting Started as a Developer

This page show how to setup as developer

Cloning Repository

Note: The repository is currently under maintenance. As a result, downloads are temporarily unavailable. Please check back later for updates.

Using docker-compose (built image for ubuntu)

version: '3.8'

services:
  sfu-app:
    container_name: sfu-app
    image: reza1290/procspy-sfu:latest
    restart: unless-stopped
    env_file:
      - ./webrtc/.env
    network_mode: "host"

  rest-api:
    container_name: procspy-api
    image: reza1290/procspy-api:latest
    restart: unless-stopped
    env_file:
      - ./rest_api/.env
    ports:
      - "1291:3000"
    depends_on:
      - mongo
    networks:
      - procspy-net

  dashboard:
    container_name: procspy-dashboard
    image: reza1290/procspy-dashboard:latest
    restart: unless-stopped
    env_file:
      - ./dashboard/.env
    expose:
      - "3000"
    depends_on:
      - rest-api
    networks:
      - procspy-net

  mongo:
    image: mongo:6
    container_name: procspy-mongo
    restart: unless-stopped
    volumes:
      - mongo_data:/data/db
    ports:
      - "27017:27017"
    environment:
      MONGO_INITDB_ROOT_USERNAME: root
      MONGO_INITDB_ROOT_PASSWORD: akujawatimur
    networks:
      - procspy-net

  nginx:
    image: nginx:latest
    container_name: nginx-proxy
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./nginx/conf.d:/etc/nginx/conf.d
      - ./certbot/www:/var/www/certbot
      - ./certbot/conf:/etc/letsencrypt
    depends_on:
      - dashboard
      - rest-api
      - sfu-app
    networks:
      - procspy-net

  certbot:
    image: certbot/certbot
    container_name: certbot
    volumes:
      - ./certbot/www:/var/www/certbot
      - ./certbot/conf:/etc/letsencrypt
    entrypoint: >
      sh -c "certbot certonly --webroot --webroot-path=/var/www/certbot
      --email [email protected] --agree-tos --no-eff-email
      -d procspy.link"
    networks:
      - procspy-net

volumes:
  mongo_data:

networks:
  procspy-net:

Setting up .env file

/dashboard/.env

# Public host to connect to REST API and WebRTC
NEXT_PUBLIC_SOCKET_HOST=localhost
NEXT_PUBLIC_SOCKET_WEB_RTC=mediasoup
NEXT_PUBLIC_JWT_SECRET=your_jwt_secret
NEXT_PUBLIC_ENDPOINT=https://api.example.com
NEXT_PUBLIC_SOCKET_URL=https://socket.example.com
NEXT_PUBLIC_STORAGE_ENDPOINT=https://api.example.com

/webrtc/.env

# Secret key for authenticating signaling communication
SECRET=your_sfu_secret

# Port the WebRTC SFU server will run on
PORT=1290

# REST API endpoint used internally by SFU
ENDPOINT=http://host.docker.internal:1291

# Optional admin secret for privileged operations
SECRET_ADMIN=your_admin_secret

# Public IP/domain used for WebRTC ICE candidates
ANNOUNCED_IP=socket.example.com

# Production or development environment
NODE_ENV=production

# Range of ports used for WebRTC media (UDP)
MIN_PORT=50000
MAX_PORT=60000

/rest_api/.env

# Port where REST API runs
PORT=3000

# Production or development mode
NODE_ENV=production

# MongoDB connection string (use authSource=admin if using root user)
MONGO_URL=mongodb://username:password@mongo-host:27017/dbname?authSource=admin

# JWT secret for API authentication
JWT_SECRET=your_jwt_secret

# Shared secret for verifying WebRTC requests
WEBRTC_SECRET=your_sfu_secret

# Allowed origins for CORS
ALLOWED_ORIGINS=https://socket.example.com,https://www.example.com,127.0.0.1

UFW Firewall Configuration for WEBRTC Connection

#! /bin/bash

# Allow basic web traffic
sudo ufw allow 80
sudo ufw allow 443

# Allow MongoDB if needed externally (optional)
sudo ufw allow 27017

# Allow WebRTC SFU port
sudo ufw allow 1290

# Allow REST API port
sudo ufw allow 1291

# Allow WebRTC dynamic UDP port range (media stream)
sudo ufw allow 50000:60000/udp

# Optional: allow the same port range for TCP (for tcp)
sudo ufw allow 50000:60000/tcp

# Enable firewall (if not enabled yet)
sudo ufw enable

# Check status
sudo ufw status