Skip to content

docs: add RDE install script documentation + fix repo URLs#143

Open
evoxmusic wants to merge 4 commits into
mainfrom
docs/rde-install-script
Open

docs: add RDE install script documentation + fix repo URLs#143
evoxmusic wants to merge 4 commits into
mainfrom
docs/rde-install-script

Conversation

@evoxmusic

Copy link
Copy Markdown
Contributor

Changes

New: Install Script Documentation

  • Added 'Using the Install Script' section to blueprint management docs covering the curl-based install approach
  • Documented .config.rde.qovery.yml configuration file with version pinning support
  • Added full component reference table (15 configurable components)
  • Added install script option to the Customization accordion
  • Updated admin setup guide to mention both template image and install script approaches

Fix: Repository URLs

  • Fixed all GitHub repo URLs from evoxmusic/remote-dev-env-template to Qovery/remote-dev-env-template (4 occurrences including the Terraform example)

Context

The RDE portal now ships an install script at https://rde.qovery.com/install.sh that users can add to any Debian/Ubuntu Dockerfile to install all Qovery RDE tools. This is an alternative to using the template base image or forking the template repository.

- Add 'Using the Install Script' section to blueprint management docs
  covering the curl-based install approach, .config.rde.qovery.yml
  configuration, version pinning, and full component reference table
- Add install script option to Customization accordion
- Update admin setup guide to mention both template and install script approaches
- Fix all GitHub repo URLs: evoxmusic/ -> Qovery/ (4 occurrences)
@evoxmusic evoxmusic requested a review from a team June 1, 2026 19:43
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 1, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
qovery-doc-mintlify-proxy b264f7c Jun 02 2026, 09:03 PM

@mintlify

mintlify Bot commented Jun 1, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
qovery 🟢 Ready View Preview Jun 1, 2026, 7:47 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@jpetitcolas jpetitcolas left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Super promising! And blazing fast! We talked about it only a few hours ago! 🚀

FROM your-org/your-base-image:latest

# Install all Qovery RDE tools (code-server, AI agents, runtimes, dev tools)
RUN curl -fsSL https://rde.qovery.com/install.sh | bash

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it too dangerous for supply-chain attacks? What about allowing to pin the version of the install script and check the checksum based on a hard-written string? With something like:

ARG QOVERY_INSTALL_VERSION=2.74.1
ARG QOVERY_INSTALL_SHA256=a62446223a42e0dc577dcead8d7bafabca4c548d9c3a6db761c6709bc8f4b373

RUN cd /tmp \
    && curl -fsSL https://rde.qovery.com/install.sh@${QOVERY_INSTALL_VERSION} -o "qovery_install.sh" \
    && echo "${QOVERY_INSTALL_SHA256}  qovery_install.sh" | sha256sum -c - \
    && bash qovery_install.sh

nodejs: "22" # Node.js 22 LTS
python: true # latest Python 3
ruby: false # skip Ruby
go: "1.24.3" # Go 1.24.3

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if you shouldn't use an object, such as:

go:
    version: "1.24.3"

That could be more furture-proof, if you want to add extra options.

| fzf | `fzf` | system | Fuzzy file finder |

<Tip>
The install script and forking the template repository are complementary approaches. Use the install script when you want to keep your existing base image and add RDE tools on top. Fork the template when you want full control over the workspace image from scratch.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How would the Dockerfile interact with the .config.rde.qovery.yml? The image is built while the config file is at the runtime, right?

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When reading this file, I still have a question in mind: how do you prevent supply chain attacks in the base Dockerfile? Perhaps adding a mention could reassure the potential readers. :)

- Add 'Integrity & Reproducibility' section documenting SHA256 verification,
  GPG-verified Node.js install, and the vendoring pattern for production
- Update RTK default version from 'latest' to '0.42.0' in components table
- Note that Qovery CLI and Skills version pinning is planned
- Document the <tool>_sha256_<arch> config keys for custom version checksums
- Fix github_cli -> gh config key in example and components table
- Fix skills -> qovery_skills config key in example
- Add 'Using custom versions' subsection under Integrity & Reproducibility
- Add rde_user to config example and Available Components table
- Add 'Custom workspace user' subsection with examples
- Document RDE_USER env var and existing user detection
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants