Skip to main content
Version: v2

Intro

Running the older split-image release?

These docs cover V2, the unified veecode/devportal:2.1.3 image driven by composable presets — the current default. If you still run V1 (the split image veecode/devportal-base + veecode/devportal, profiles via VEECODE_PROFILE), see the V1 documentation. Not sure which you run? See Which version am I running?.

Welcome to VeeCode Developer Portal documentation. This guide covers installation, plugins, and concepts for running DevPortal on your infrastructure.

What is VeeCode DevPortal?​

VeeCode DevPortal is an open-source platform built on top of Backstage, an open-source developer portal framework created by Spotify. Backstage has a growing community and is being used by many organizations, including large technology companies like Google, Microsoft, and Verizon.

VeeCode DevPortal is a Backstage distro that provides a production-grade portal on day one: catalog, software templates, tech docs, search, and SSO already wired.

Here are some key points about the Developer Portal​

  • It is a powerful tool that helps developers' self-service experience when developing APIs and services
  • It is a catalog of software and IaC templates for autonomous teams to use
  • It is an API showcase and governance tool for both developers and business partners
  • It simplifies DevOps adoption and scaling, removing cognitive load from average teams

If you want to understand why this portal matters before diving into setup — the reasoning behind golden paths, self-service design, and developer autonomy — start with Platform Concepts. If you're here to install and configure, continue below.

💻 Installation Guide

Learn how to install the Developer Portal on your own infrastructure.

💡 Concepts

Understand the core concepts and terminology related to the Developer Portal.

🧩 Plugins

Enable and configure plugins to extend DevPortal with Day-2 capabilities.

📍 Troubleshooting

Find solutions to common issues and learn how to report errors.

By the end of this guide, you should have a good understanding of how the Developer Portal works and how it can help you better manage your API and service ecosystem. Let's get started!