Home

Codex Web Documentation

Welcome to the Codex Web documentation! Codex Web is a multi-tenant Kubernetes-based development platform that enables users to create, manage, and access cloud-based development workspaces.

Quick Links

For Users

• Getting Started - First time using Codex Web? Start here!
• Managing Workspaces - Create, start, stop, and manage your development environments
• Understanding Groups - Learn about teams and resource organization
• Accessing Your Workspace - How to log into and use your workspace

For Administrators

• Admin Overview - Introduction to platform administration
• User Account Management - Creating and managing user accounts
• Privilege Guidelines - Understanding roles and permissions
• Group Management - Creating and configuring groups
• Workspace Administration - Managing workspaces as an admin

Reference

• Quick Reference - Common commands and actions
• Troubleshooting - Solutions to common problems
• FAQ - Frequently asked questions

What is Codex Web?

Codex Web provides cloud-based development environments that run in Kubernetes. Key features include:

• Browser-based IDE: Access VS Code from any browser
• Multi-tenant Architecture: Isolated workspaces organized by groups
• Resource Management: CPU, memory, and storage quotas per group
• Persistent Storage: Your code and files are preserved between sessions
• OAuth Authentication: Secure login via AWS Cognito or Google
• Scalable: Start and stop workspaces on demand

Architecture Overview

┌─────────────────────────────────────────────────┐
│           Users (OAuth Login)                    │
└──────────────────┬──────────────────────────────┘
                   │
┌──────────────────▼──────────────────────────────┐
│         Codex Web Frontend (React)              │
└──────────────────┬──────────────────────────────┘
                   │
┌──────────────────▼──────────────────────────────┐
│      Codex Web Backend (Express API)            │
└──────────────────┬──────────────────────────────┘
                   │
        ┌──────────┴──────────┐
        │                     │
┌───────▼────────┐   ┌───────▼─────────┐
│   DynamoDB     │   │   Kubernetes    │
│  (Metadata)    │   │  (Workspaces)   │
└────────────────┘   └─────────────────┘

User Roles

Regular User

• Create and manage personal workspaces
• Access workspaces in assigned groups
• View group information and resource usage

Group Admin

• All regular user permissions
• Manage all workspaces within their group(s)
• Cannot add/remove group members

Platform Admin

• Full access to all groups and workspaces
• Create and manage groups
• Manage user accounts and permissions
• View platform-wide statistics and logs

Getting Help

• Technical Issues: Check the Troubleshooting guide
• Questions: See the FAQ
• Support: Contact your platform administrator

Contributing

For developers working on Codex Web, see:

• Main repository: github.com/genesis-ai-dev/web-codex
• Developer documentation: See CLAUDE.md in the repository
• Technical README: See backend/README.md and frontend/README.md

---

Documentation Version: 1.0 Last Updated: December 2024