Skip to main content

DevPortal Commands

Overview

These commands are related to installing and managing VeeCode DevPortal, a ready-to-use Backstage distribution for developer portals.

VeeCode DevPortal provides:

  • Service catalog for your organization
  • Software templates for creating new projects
  • TechDocs for documentation
  • Integration with GitHub, GitLab, Azure DevOps, and LDAP

Prerequisites

DevPortal requires Kong Gateway as the ingress controller:

vkdr infra up
vkdr kong install --default-ic

Available Commands

  • devportal - Install and manage VeeCode DevPortal

Quick Start

Local Development (with samples)

# Start cluster with Kong
vkdr infra up
vkdr kong install --default-ic

# Install DevPortal with sample catalog
vkdr devportal install --samples

# Access at http://devportal.localhost:8000

With GitHub Integration

vkdr infra up
vkdr kong install --default-ic

# Install with GitHub PAT (simplest)
vkdr devportal install \
--profile github-pat \
--github-org myorg \
--github-token ghp_xxxxxxxxxxxx

# Access at http://devportal.localhost:8000

Authentication Profiles

ProfileBest ForComplexity
github-patQuick testingSimple
githubProductionMedium
gitlabGitLab usersMedium
azureAzure DevOps usersMedium
ldapEnterprise LDAPMedium

Integration with Other Services

DevPortal works well with other vkdr services:

# Full stack setup
vkdr infra up
vkdr kong install --default-ic
vkdr postgres install -w # For DevPortal database
vkdr keycloak install # For SSO authentication
vkdr devportal install --profile github-pat --github-org myorg --github-token ghp_xxxx