Skip to main content

Documentation Index

Fetch the complete documentation index at: https://www.qovery.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Preview: Remote Dev Environments Portal is currently in preview. Features and capabilities are under active development and may change.

​
Overview

This guide walks you through creating your first workspace in the RDE Portal. You will pick a blueprint, name your workspace, and start developing - all from your browser.

​
Prerequisites

A Qovery account in an organization with the RDE Portal add-on enabled (Business or Enterprise plan)
At least one blueprint available in the catalog (configured by your admin - see Admin Setup)

​
Create a Workspace

1

Log in to the Portal

Go to rde.qovery.com and log in with your Qovery credentials. Authentication uses the same login as the Qovery Console - no additional signup required.
2

Browse the Blueprint Catalog

On the workspace dashboard, you will see available blueprints displayed as a horizontal card list. Each card shows the blueprint name and a Launch button.Only blueprints your admin has granted you access to will appear in the catalog.
3

Launch a Workspace

Click Launch on the blueprint you want to use. Give your workspace a name - you can rename it later by clicking the name in the top bar.The portal clones the blueprint environment and starts deploying your isolated workspace.
4

Wait for Deployment

The portal shows real-time provisioning progress as your workspace is created. You will see each phase as it completes:
  1. Validating - Checking blueprint configuration and your permissions
  2. Creating project - Setting up the isolated Qovery project for your workspace
  3. Cloning blueprint - Copying the blueprint environment into your workspace
  4. Configuring - Applying settings, environment variables, and access controls
  5. Deploying - Building and starting your workspace containers (this is the longest phase, typically 1-3 minutes)
  6. Finalizing - Verifying all services are running
You will be redirected to the workspace editor automatically once all phases complete.
Each workspace is a fully isolated clone of the blueprint environment. Your changes do not affect other users’ workspaces or the original blueprint.

​
Explore the Workspace Editor

Once your workspace is ready, the editor opens in a split-pane layout: tools on the left, live preview on the right.

​
Left Panel - Terminals and Chat

The left panel contains preconfigured tabs along the top. Depending on your admin’s configuration, you may see:
  • Chat - AI chat powered by OpenCode for asking questions, generating code snippets, and getting contextual help.
  • Claude Code - AI-assisted terminal that can generate and edit code, run commands, and navigate your project.
  • Terminal - Standard bash shell running in your workspace container. Full access to your project files and installed tools.
  • Custom command tabs - Admin-defined tabs that run specific commands (e.g., linting, test suites, build scripts).
Click any tab to switch between tools. You can have multiple terminals open simultaneously.

​
Right Panel - Live Preview

The right panel renders your running application directly in the browser. Use the viewport switcher (desktop, tablet, and mobile icons) in the preview toolbar to test responsive layouts. Toggle auto-refresh to automatically reload the preview when your application rebuilds. You can also manually refresh with the reload button.

​
Top Bar

The top bar displays:
  • Logo - click to return to the workspace dashboard
  • Workspace name - the name of your current workspace
  • Deployment status - current state of your environment
  • Publish - submit your application for production deployment
  • Actions menu (…) - workspace actions including Restart, Stop, and Delete

​
Your First Commands

Open the Terminal tab and run a few commands to orient yourself: 
# See what's in your workspace
ls -la

# Check installed tools
node --version    # or python3, go, etc.
git status

# Start the dev server (varies by blueprint)
npm run dev       # Node.js example
Your workspace comes preconfigured with the tools and dependencies defined in the blueprint. The dev server command depends on the technology stack your admin has set up.
Use the Claude Code tab to ask questions like “What’s the project structure?” or “How do I start the dev server?” - it has full context of your workspace.

​
Save Your Work

The portal uses git snapshots to version your work. Press Cmd+S (macOS) or Ctrl+S (Windows/Linux) to create a snapshot at any time. Each snapshot creates a git commit of your current workspace state. You can browse and restore previous snapshots from the History panel in the top bar.
Snapshots are local to your workspace. They do not push to any external Git repository. Use the Publish workflow when you are ready to deploy your changes.

​
Publish Your Application

Once you have built something you want to share, use the Publish workflow:
  1. Click the Publish button in the top bar.
  2. Choose a subdomain for your published application.
  3. Submit the publish request.
  4. Your admin reviews and approves the deployment.
  5. Your application goes live at the assigned URL.
Publishing is covered in detail in the Publishing Your App guide.

​
Troubleshooting

Deployment typically takes 2-4 minutes. If your workspace has not reached Running status after 5 minutes:
  • Go back to the workspace dashboard and try restarting the workspace.
  • Check if the blueprint’s source environment is healthy in the Qovery Console.
  • Contact your admin if the issue persists - there may be a cluster resource or configuration problem.
Your admin has not configured access for your account yet. Contact your admin and ask to be added to a blueprint’s access control list. They can grant access by email address or email domain.
The terminal uses WebSocket connections that may disconnect after idle periods.
  • Refresh the page to re-establish the connection.
  • If the terminal still does not connect, check your browser’s network tab for WebSocket errors.
  • Ensure your network or VPN allows WebSocket connections to your portal URL.
The preview panel shows your running application. If it is blank or shows an error:
  • Check the terminal for application errors - your dev server may not be running yet.
  • Make sure your application is listening on the expected port.
  • Try manually starting the dev server from the terminal.
  • Click the refresh button in the preview toolbar.

​
Next Steps

Using the Editor

Master the workspace editor layout, keyboard shortcuts, and productivity features.

Live Preview

Viewport switching, auto-refresh, and testing responsive layouts.

Publishing Your App

Submit your application for production deployment with subdomain selection.

Git History & Snapshots

Browse, compare, and restore previous workspace snapshots.