-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Started
This guide will help you get started with Codex Web, from your first login to creating your first workspace.
Before you begin, you need:
- An invitation to the Codex Web platform
- An account with your organization's authentication provider (AWS Cognito or Google)
- A modern web browser (Chrome, Firefox, Safari, or Edge)
- Navigate to your organization's Codex Web URL
- Click the Login button
- You'll be redirected to your authentication provider
- Sign in with your credentials
- After successful authentication, you'll be redirected to your Codex Web dashboard
On your first login, you'll see:
- An empty dashboard (no workspaces yet)
- The groups you've been assigned to
- Resource quotas available to you
The Codex Web interface has several main sections:
Dashboard
- Overview of your workspaces
- Quick access to running workspaces
- Resource usage summary
Workspaces
- List of all your workspaces
- Create new workspaces
- Manage existing workspaces
Groups
- View groups you belong to
- See group members and resources
- Monitor group resource usage
Profile (top-right menu)
- View your account information
- Update profile settings
- Change password (redirects to auth provider)
The dashboard provides an at-a-glance view of:
- Total number of workspaces you have access to
- How many are currently running
- Quick actions for each workspace
- CPU usage across all your workspaces
- Memory consumption
- Storage used
- Visual indicators when approaching limits
- Recently accessed workspaces
- Workspace status changes
Your account includes:
- Name: Your display name
- Email: Your email address from the auth provider
- Username: Your login identifier
- Groups: Teams/organizations you belong to
- Role: Your permission level (User, Group Admin, or Platform Admin)
As a regular user, you can:
- Create workspaces in groups you belong to
- Manage your own workspaces
- View group information
- Access resources within group quotas
See Privilege Guidelines for details on different roles.
Before creating a workspace:
- Go to the Groups section
- Verify you belong to at least one group
- Note the group's available resources
If you don't belong to any groups, contact your administrator.
-
Navigate to Workspaces
-
Click Create New Workspace
-
Fill in the details:
- Name: Choose a descriptive name (e.g., "Frontend Development")
- Description (optional): Add notes about the workspace purpose
- Group: Select which group this workspace belongs to
- Resource Tier: Choose based on your needs (see below)
-
Click Create Workspace
After creation, you'll see a password displayed. Save this password securely!
You'll need this password to access your workspace. The platform does not store this password in a recoverable format.
- Your new workspace starts in "Stopped" state
- Click the Start button
- Wait for status to change to "Running" (30-60 seconds)
- Click Open to access your workspace
Select a tier based on your workload:
| Tier | Best For | Example Use Cases |
|---|---|---|
| Single User | Light development, testing | Editing configs, reviewing code, small scripts |
| Small Team | Most development work | Web development, API development, typical coding |
| Enterprise | Resource-intensive tasks | Building large projects, running databases, ML work |
Tip: Start with a smaller tier and upgrade if needed. You can always create a new workspace with more resources.
Once your workspace is running:
- Click the Open button on your workspace card
- A new tab opens with your workspace URL
- Enter your workspace password
- Press Submit
You're now in your cloud development environment!
Your workspace includes:
- Full-featured code editor
- Terminal access
- File explorer
- Extension marketplace
Your files are stored at:
/workspace/.codex-projects
Files in this directory persist when you stop/start the workspace.
Important: Files outside this directory may be lost when the workspace restarts!
- Click the terminal icon or press
Ctrl/Cmd + ` - You have full shell access
- Pre-installed tools vary by workspace image
-
Morning:
- Log into Codex Web
- Start your workspace
- Wait for "Running" status
- Open workspace
-
During Work:
- Write code
- Use git for version control
- Install needed extensions/packages
- Save work frequently
-
End of Day:
- Commit and push code to git
- Close workspace browser tab
- Stop workspace in Codex Web
Resource Management
- Stop workspaces when not in use
- Monitor your resource consumption
- Choose appropriate resource tiers
Data Safety
- Always use git repositories
- Push code regularly
- Don't rely solely on workspace storage
- Keep persistent files in
/workspace/.codex-projects
Security
- Keep workspace passwords secure
- Don't share workspace access
- Log out when done
- Don't store secrets in code
Yes! Create as many as you need, subject to your group's resource limits.
Files in /workspace/.codex-projects are preserved. Other files may be lost.
Yes! Install VS Code extensions, modify settings, install packages. Extensions persist between restarts.
Use git repositories. Each workspace is isolated, so file sharing happens via external repos.
Contact your group admin or platform admin. They cannot retrieve it, but can help you create a new workspace.
Now that you're set up:
- Managing Workspaces - Learn all workspace operations
- Understanding Groups - Deep dive into group concepts
- Accessing Your Workspace - Detailed workspace usage guide
- Troubleshooting - Solutions to common issues
If you encounter issues:
- Check the Troubleshooting guide
- Review the FAQ
- Contact your group admin
- Reach out to platform administrators
Next: Managing Workspaces →