Platform Overview

Pushpaka is a self-hosted deployment control plane for teams that want Git-based delivery, AI-assisted monitoring, and infrastructure operations in one product. The current codebase already includes Docker and Kubernetes controls, AI monitoring and log analysis, a built-in Monaco editor, web terminal access, rollbacks, notifications, OAuth, webhooks, and Traefik-powered routing.

Supported Delivery Targets

Docker containers, Kubernetes-oriented deployments, and direct runtime fallback when Docker is unavailable.

Operator Workflows

Deploy, inspect logs, analyze with AI, edit source, open terminal, restart infra, and roll back from one system.

Runtime Modes

Single-binary dev mode, all-in-one mode, or split API and worker components for horizontal scale.

Enterprise Surfaces

Health, readiness, metrics, AI usage limits, audit-like activity, notifications, infra operations, and guided troubleshooting.

Installation For Every Platform

Choose the installation path that matches how your team wants to evaluate or run Pushpaka.

Docker Compose Production Install

Best default for production evaluation and self-hosted deployments.

git clone https://github.com/vikukumar/pushpaka
cd Pushpaka
cp .env.example .env
# Set DOMAIN, JWT_SECRET, POSTGRES_PASSWORD, REDIS_PASSWORD, ACME_EMAIL
docker compose up -d --build

Single Binary Dev Mode

Fastest local path. No Docker, Redis, or PostgreSQL required.

cd cmd/pushpaka
go build -o pushpaka .
./pushpaka -dev

Frontend Dashboard

Run the operator dashboard separately when developing locally.

cd frontend
pnpm install
pnpm dev

Helm Installation

Use the Helm chart for cluster-native rollout and lifecycle management.

helm repo add pushpaka https://pushpaka.vikshro.in/helm
helm repo update
helm install pushpaka pushpaka/pushpaka

For production installs, expect to configure domain routing, secrets, database access, Redis, and Let’s Encrypt contact details before exposing the platform publicly.

Upgrade Guide

Use a repeatable upgrade flow so your platform state and deployment history stay intact.

Back Up Data

Export PostgreSQL or copy the SQLite database before changing binaries or images.

Pull New Release Assets

Upgrade from GitHub release binaries, a new Docker image tag, or an updated Helm chart version.

Apply Infrastructure Update

Run `docker compose up -d --build`, replace the binary, or run `helm upgrade` depending on your installation path.

Validate Health And Feature Surfaces

Check `/health`, `/ready`, `/system`, log streaming, AI settings, editor access, and deployment execution before declaring success.

Step-By-Step Deployment Workflow

Create A Project

Set repository URL, branch, build command overrides, deploy target, and runtime settings in project creation or settings.

Configure Secrets And Environment Variables

Add project-level environment variables. Values are write-only in the API and UI.

Trigger Deployment

Start from the dashboard or API. Pushpaka clones, detects the stack, generates Docker assets if needed, and starts the deployment flow.

Monitor Logs In Real Time

Use WebSocket streaming and deployment log history to inspect build and runtime behavior.

Rollback When Needed

Use the rollback endpoint or dashboard action to recover to a previous deployment version quickly.

AI Operations

Pushpaka already exposes AI configuration, AI usage, RAG documents, AI monitoring alerts, and deployment log analysis.

1. Configure AI Provider

Open Settings → AI and set provider, model, API key, system prompt, and monitoring interval.

2. Enable Monitoring

Turn on monitoring to let Pushpaka persist AI-generated alerts for failed or problematic deployments.

3. Analyze Deployment Logs

Use AI analysis on a deployment to summarize failures and propose next actions for remediation.

4. Add RAG Knowledge

Store runbooks, internal docs, or platform standards as RAG documents to improve AI answers.

Built-In Editor And Web Terminal

Open The Project Editor

Use the project editor view to browse source files from the working directory with Monaco-based editing.

Sync Latest Source

Use source sync to refresh the editor workspace from the repository clone without requiring a full deployment first.

Save Carefully

Save small text-based changes directly in the editor. Very large or binary files are intentionally blocked by the backend.

Use Terminal For Live Inspection

Open the deployment terminal to inspect a running container, validate runtime state, or execute targeted troubleshooting commands.

Domains, TLS, And Routing

Add Domain In Project Settings

Attach the hostname to the target project from the dashboard.

Update DNS

Point your DNS record to the Pushpaka entrypoint handled by Traefik.

Wait For TLS Provisioning

Traefik and Let’s Encrypt complete certificate provisioning automatically after DNS is correct.

Infrastructure Controls

Docker Operations

List containers, start, stop, restart, and read container logs from the platform.

Kubernetes Operations

View namespaces, pods, deployments, services, and trigger rollout restarts when `kubectl` access is configured.

Health And System Visibility

Use `/health`, `/ready`, and `/system` to confirm database, Redis, Docker, Git, runtime mode, and worker state.

Integrations And Automation

OAuth

GitHub and GitLab OAuth handlers are present for login and repository-adjacent flows.

Webhooks

Create per-project webhooks so incoming Git events can trigger automated deployment behavior.

Notifications

Configure Slack, Discord, and SMTP settings to push deployment results to your preferred channels.

API-First Use

Most operational paths also exist through `/api/v1` for internal platform automation.

API Usage

Authenticate with a bearer token and use the platform endpoints for projects, deployments, logs, AI operations, infra, domains, notifications, and webhooks.

export PUSHPAKA_TOKEN="replace-with-your-token"

curl -X GET https://your-instance.com/api/v1/projects \
  -H "Authorization: Bearer ${PUSHPAKA_TOKEN}"

Use the API for automated deployment triggers, health validation, deployment history, AI workflows, infra inspection, and notification setup.

Common Errors And How To Handle Them

Docker Not Available

Pushpaka can fall back to direct deploy, but validate host runtime expectations and check `/system` for Docker visibility.

AI Not Configured

Set `AI_API_KEY` globally or configure user-level AI settings before using AI analysis or assistant chat.

kubectl Error

Check cluster access, kubeconfig, namespace, and whether Kubernetes integration is enabled for the user.

Domain Or TLS Delay

Validate DNS first. Traefik and Let’s Encrypt cannot complete until the hostname resolves correctly to the platform edge.

Editor Cannot Open File

Large files and binary files are intentionally blocked. Use the editor for text-based operational changes and the repository for larger updates.

Support Paths

Use the right support path based on whether you need issue tracking, architecture discussion, or operating guidance.

Report Issues Join Discussions

Operate Pushpaka Like A Platform Team