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. Setup steps may change as the product evolves.

​
Overview

As an admin, you configure the RDE Portal so your team can create their own workspaces. This guide walks through the complete setup - from portal configuration to inviting your first builder.

​
Prerequisites

Before starting, make sure you have:
Qovery account on a Business or Enterprise plan with the RDE Portal add-on enabled - see Pricing
Organization admin access on your Qovery account
A running Kubernetes cluster on Qovery
At least one project with an environment to use as a blueprint template

​
Step 1: Configure Your Organization

Connect the portal to your Qovery organization and apply your branding.
1

Open the RDE Portal

Go to rde.qovery.com and log in with your Qovery credentials. You must have organization admin access to see the admin panel.
2

Select Your Organization

Choose the Qovery organization you want to configure for remote dev environments.
3

Click Configure Portal

Click Configure Portal to initialize the portal for your organization. The portal automatically creates and securely stores an admin API token - no manual token setup required.
When you click Configure Portal, the portal automatically provisions a secure admin token encrypted with AES-256-GCM at rest. This token allows the portal to perform privileged operations (cloning environments, managing deployments) on behalf of your users. It is never exposed to end users and is never visible in the portal UI after creation.
4

Customize Portal Branding

Navigate to Admin > Settings and configure the following to match your organization:
  • Portal name - displayed in the header and browser tab
  • Logo (Light mode) - your company logo for light backgrounds
  • Logo (Dark mode) - optional logo variant for dark backgrounds (falls back to the light logo if not set)
  • Accent color - applied to buttons, links, and accent elements throughout the portal
5

Configure the Welcome Screen (Optional)

Customize what builders see on their first login:
  • Welcome title - the headline on the landing page
  • Welcome description - a brief description of what the portal offers
  • CTA text - the label on the primary call-to-action button

​
Step 2: Register a Blueprint

Blueprints are Qovery environments that serve as templates. When a builder creates a workspace, the portal clones the blueprint environment into their own isolated copy.
1

Open the Blueprints Page

Navigate to Admin > Blueprints from the sidebar.
2

Register a New Blueprint

Click Register Blueprint to start the registration flow.
3

Select the Qovery Project

Choose the Qovery project that contains your template environment. The portal discovers all available environments within the selected project.
4

Choose the Template Environment

Select the environment you want to use as the blueprint. This environment will be cloned each time a builder creates a workspace from this blueprint.
5

Set Display Name and Description

Give the blueprint a display name that builders will see in the catalog (e.g., “Full-Stack Starter” or “Backend API”). Add an optional description to help builders understand what the blueprint includes.
New blueprints start in Testing state. After verifying the blueprint works correctly, change its state to Enabled in the blueprint detail page to make it available to builders. See Blueprint Management for details.
Start with a simple blueprint - a single workspace container with basic dev tools. You can always add databases, services, and advanced configuration later. Need a ready-made image? Use the official workspace template - an all-in-one image with code-server, Claude Code, OpenCode, and multi-language support. See Blueprint Management for details.

​
Step 3: Configure Access Control

Control who can use each blueprint with access control lists (ACLs).
1

Open the Blueprint Detail Page

From Admin > Blueprints, click on the blueprint you just registered.
2

Go to Access Control

Click the Access Control tab on the blueprint detail page.
3

Choose an Access Policy

Select who can create workspaces from this blueprint:
  • Open access - anyone in your organization can use this blueprint
  • Domain-restricted - only users with specific email domains (e.g., @yourcompany.com)
  • Email-restricted - only specific email addresses you define
4

Save ACL Rules

Click Save to apply the access control rules. Changes take effect immediately.
You can combine domain and email restrictions. For example, allow all @yourcompany.com users plus a few external contractors by email.

​
Step 4: Configure Blueprint Settings

Optionally fine-tune each blueprint with AI provider configuration and workspace layout settings.

​
AI Configuration

Configure AI providers for the workspace in a unified panel. Each provider can be independently enabled:
  • Anthropic - Powers Claude Code and can power the Chat panel. Choose between User OAuth (builders use their own account) or API Key injection (seamless, billed to your organization).
  • OpenAI - Powers the Chat panel with GPT models. Requires an API key.
  • Custom provider - Any OpenAI-compatible API endpoint for the Chat panel. Useful for internally hosted models.

​
Layout

Control which tabs appear in the workspace editor:
  • Chat - OpenCode AI chat panel
  • Claude Code - AI-assisted terminal
  • Terminal - standard bash shell
  • Custom commands - admin-defined command tabs
You can also lock the layout to prevent builders from rearranging tabs, and toggle preview panel visibility to show or hide the live app preview by default.

​
Step 5: Invite Members

Add team members so they can log in and create workspaces.
1

Open the Members Page

Navigate to Admin > Members from the sidebar.
2

Invite by Email

Enter team member email addresses and send invitations. Members receive an email with a link to log in via SSO.
3

Assign Roles

Assign Qovery roles as needed. Builders only need basic access - admin access is required only for portal configuration.

​
Verify Your Setup

Before rolling out to your team, confirm everything works end-to-end.
  1. Log out of your admin account and log back in with a non-admin test account (or use a colleague’s account).
  2. Verify the blueprint catalog is visible and shows the blueprints you registered.
  3. Create a test workspace from one of the blueprints. Confirm it deploys successfully and the editor loads.
  4. Delete the test workspace from the dashboard when you are done.
If you used email-restricted access, make sure the test account’s email is in the allow list before testing.

​
Next Steps

Create Your First Workspace

Spin up your first development environment and start building.

Blueprint Management

Advanced blueprint configuration, versioning, and lifecycle management.

Portal Customization

Theming, welcome screen, and branding options.