Project Management

Projects are the foundational organizational unit in Erebus platform. Each project provides an isolated environment for your real-time applications with dedicated API keys, analytics, audit logs, and configuration settings.

Project Overview

What is a Project?

A project in Erebus represents a single real-time application or service. Each project includes:

• Isolated Environment: Separate namespace for channels, users, and data
• Dedicated API Keys: Independent authentication and access control
• Individual Analytics: Project-specific metrics and usage tracking
• Separate Audit Logs: Security and activity logging per project
• Custom Configuration: Project-specific settings and integrations

[Screenshot placeholder: Projects dashboard showing multiple projects]

Project Limits

• Maximum Projects: 50 projects per account
• Project Names: 3-100 characters, customizable at any time
• API Keys: Unlimited API keys per project
• Regional Deployment: Global (auto-region) and EU options

Creating Projects

Project Creation Process

[Screenshot placeholder: Create project dialog with form fields]

1. Navigate to Projects: Go to your account dashboard
2. Click "Create new project": Opens the project creation dialog
3. Enter Project Details:
   • Project Title: Descriptive name (3-100 characters)
   • Region Selection: Choose deployment region
4. Click "Create Project": Project is created instantly

Region Selection

Global Region (Recommended)

• Automatically routes users to the nearest Cloudflare edge location
• Optimal performance for worldwide applications
• Uses intelligent geo-routing for minimal latency
• Best choice for most applications

EU Region (Coming Soon)

• Fixed deployment in European Union data centers
• Compliance with EU data sovereignty requirements
• Suitable for GDPR-strict applications
• Fixed regional deployment

Project Naming

Naming Guidelines

• Length: 3-100 characters
• Characters: Letters, numbers, spaces, and common punctuation
• Uniqueness: Project names must be unique within your account
• Flexibility: Names can be changed anytime via project settings

Best Practices

• Use descriptive names that identify the application purpose
• Include environment indicators if managing multiple stages
• Consider version numbers for iterative development
• Keep names concise but informative

Project Dashboard

Navigation Overview

[Screenshot placeholder: Project dashboard with sidebar navigation]

Each project provides a comprehensive dashboard with dedicated sections:

Dashboard

• Real-time analytics overview
• Connection metrics and message volume
• Quick access to recent activity
• Performance at a glance

Usage

• Detailed analytics with time-range selection
• Historical data and trends
• Peak usage identification
• Usage optimization insights

API Keys

• Manage authentication credentials
• Environment-based organization
• Key status and permissions
• Security controls

Audit Logs

• Complete activity tracking
• Security and compliance monitoring
• Change attribution and timing
• Event history and patterns

Settings

• Project configuration
• Webhook integrations
• Name and metadata management
• Advanced project options

Dashboard Analytics

[Screenshot placeholder: Analytics dashboard with metrics cards]

The project dashboard provides immediate insights:

Real-Time Metrics

• Active Connections: Current connected users
• Messages per Second: Real-time message throughput
• Active Channels: Number of channels with activity
• Subscription Count: Total active subscriptions

Historical Overview

• Connection trends: Usage patterns over time
• Peak performance: Highest usage periods
• Growth metrics: Application scaling insights
• Error rates: System health indicators

Project Settings

Basic Configuration

[Screenshot placeholder: Project settings page with form fields]

Project Name Management

1. Navigate to "Settings" in your project
2. Update the "Project Name" field
3. Click "Update Project Name"
4. Changes are applied immediately and logged in audit trails

Project Information Display

• Project Slug: Immutable URL-friendly identifier
• Creation Date: When the project was established
• Current Status: Active, archived, or maintenance
• Deployment Region: Selected regional configuration

Webhook Configuration

[Screenshot placeholder: Webhook URL configuration interface]

Webhooks enable you to forward real-time messages to your backend services for processing, storage, or integration with other systems.

Webhook Setup

URL Requirements

• Protocol: Must use HTTPS for security
• Format: Base URL only (e.g., https://api.yourapp.com)
• No Paths: System automatically appends /erebus/webhook
• Validation: Real-time URL format validation

Configuration Process

1. Enter your base HTTPS URL in the webhook field
2. System validates URL format automatically
3. Click "Update Webhook URL" to save
4. Webhooks become active immediately

Webhook Validation Rules

The system enforces strict validation:

Valid Examples

• https://api.myapp.com
• https://webhooks.example.org
• https://myservice.herokuapp.com

Invalid Examples

• http://api.myapp.com (HTTP not allowed)
• https://api.myapp.com/erebus (paths not allowed)
• api.myapp.com (protocol missing)

Message Forwarding

Forwarded Data Structure

{
  "projectId": "proj_01HQXYZ456ABC789",
  "channel": "chat:general",
  "message": {
    "id": "msg_01HQXYZ123ABC456",
    "payload": "Hello, world!",
    "timestamp": 1699123456789,
    "userId": "user_01HQXYZ789DEF123"
  },
  "metadata": {
    "origin": "erebus-platform",
    "version": "1.0"
  }
}

Delivery Guarantees

• At-least-once delivery: Messages are delivered reliably
• Retry logic: Failed deliveries are automatically retried
• Timeout handling: Configurable timeout for webhook endpoints
• Error logging: Delivery failures are logged for debugging

Advanced Settings

Project Status Management

• Active: Normal operation with full functionality
• Archived: Read-only access, no new connections allowed
• Maintenance: Temporary operational restrictions

Performance Configuration

• Connection limits: Per-project connection quotas
• Rate limiting: Message throughput controls
• Channel restrictions: Namespace-based access controls

Project Organization

Multi-Project Strategies

Environment Separation

my-app-development
my-app-staging
my-app-production

Feature-Based Organization

chat-service
notifications-service
analytics-service

Client-Based Projects

client-alpha-app
client-beta-app
internal-tools

Project Lifecycle

Development Phase

• Use development API keys
• Configure webhook to staging endpoints
• Enable comprehensive audit logging
• Monitor usage patterns

Production Deployment

• Generate production API keys
• Update webhook to production endpoints
• Configure appropriate rate limits
• Establish monitoring and alerting

Maintenance and Updates

• Use audit logs for change tracking
• Coordinate API key rotation
• Monitor performance impacts
• Plan capacity scaling

Project Deletion

Deletion Restrictions

[Screenshot placeholder: Project deletion dialog with restrictions]

Projects cannot be deleted if they contain:

Usage Data

• Historical analytics data
• Message logs or history
• Connection records
• Performance metrics

Active Resources

• Active API keys
• Webhook configurations
• Active subscriptions
• Real-time connections

Safe Deletion Process

Pre-Deletion Steps

1. Revoke all API keys: Ensure no active authentication
2. Disconnect all clients: Terminate active connections
3. Clear webhooks: Remove integration endpoints
4. Export data: Download any required audit logs or analytics

Deletion Confirmation

• Double confirmation: Multiple confirmation steps required
• Impact warning: Clear explanation of what will be lost
• Audit logging: Deletion attempts are logged even if unsuccessful

Monitoring and Maintenance

Health Monitoring

Alerting Strategies

• Monitor audit logs for security events
• Track usage patterns for capacity planning
• Set up external monitoring for webhook endpoints
• Review API key usage patterns regularly

Regular Maintenance Tasks

Weekly Reviews

• Audit log review: Security and compliance monitoring
• API key audit: Remove unused or compromised keys
• Usage analysis: Identify optimization opportunities
• Webhook validation: Ensure endpoints are responding correctly

Monthly Tasks

• Performance analysis: Deep dive into usage patterns
• Security review: Comprehensive access and permission audit
• Configuration cleanup: Remove unused settings and resources
• Capacity planning: Prepare for growth and scaling

Best Practices

Security

API Key Management

• Generate separate keys for development and production
• Rotate keys regularly and revoke unused keys
• Monitor key usage patterns in audit logs
• Use environment-specific key labeling

Access Control

• Limit project access to necessary team members
• Use audit logs to monitor administrative actions
• Implement webhook endpoint security measures
• Regular review of project permissions

Performance

Optimization Strategies

• Monitor connection patterns to optimize client behavior
• Use analytics to identify peak usage periods
• Configure webhooks efficiently to avoid bottlenecks
• Plan capacity based on growth trends

Scaling Preparation

• Monitor usage trends for capacity planning
• Prepare webhook endpoints for increased traffic
• Consider regional deployment for global applications
• Plan API key rotation strategies for high-traffic systems

Getting Help

Documentation Resources

• Getting Started Guide - Initial project setup
• API Key Management - Authentication best practices
• Audit Logs - Security and compliance tracking

Support Channels

• Email Support: hey@v0id.me for project management questions
• Documentation: Comprehensive guides for all platform features
• Community: Updates and announcements at x.com/v0id_user

Organization is Key: Well-organized projects with proper naming, security practices, and monitoring form the foundation of successful real-time applications. Take time to establish good practices early in your development process.