{"id":51020988,"url":"https://github.com/theolujay/appa","last_synced_at":"2026-06-21T16:30:26.951Z","repository":{"id":354441627,"uuid":"1220803880","full_name":"theolujay/appa","owner":"theolujay","description":"Minimal, zero-config deployment platform that handles building, orchestration, and routing with ease.","archived":false,"fork":false,"pushed_at":"2026-05-30T09:13:15.000Z","size":1498,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-30T11:11:14.376Z","etag":null,"topics":["deployment","paas"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/theolujay.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-25T11:00:41.000Z","updated_at":"2026-05-30T09:13:19.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/theolujay/appa","commit_stats":null,"previous_names":["theolujay/appa"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/theolujay/appa","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theolujay%2Fappa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theolujay%2Fappa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theolujay%2Fappa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theolujay%2Fappa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/theolujay","download_url":"https://codeload.github.com/theolujay/appa/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/theolujay%2Fappa/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34618472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-21T02:00:05.568Z","response_time":54,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deployment","paas"],"created_at":"2026-06-21T16:30:25.924Z","updated_at":"2026-06-21T16:30:26.938Z","avatar_url":"https://github.com/theolujay.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Appa\n\n[![CI](https://github.com/theolujay/appa/actions/workflows/ci.yml/badge.svg)](https://github.com/theolujay/appa/actions/workflows/ci.yml)\n[![Go Report Card](https://goreportcard.com/badge/github.com/theolujay/appa)](https://goreportcard.com/report/github.com/theolujay/appa)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nAppa is a self-hosted, CLI-native deployment platform. Bring your own VPS, connect your domain, and deploy apps from Git repositories or ZIP uploads—without writing Dockerfiles, configuring web servers, or managing routing manually.\n\n![Appa dashboard](main.png)\n\n## Architecture Overview\n\n```\nOperator Machine (Local)             Remote Server (VPS)\n └─ Appa CLI (appa)                    ├─ Caddy Gateway (public proxy, automatic HTTPS)\n     │                                 ├─ Appa API (Go, WS log broadcaster)\n     │ SSH + Ansible (setup/apply)     ├─ React Dashboard (dashboard UI)\n     └─────────────────────────────────┼─ BuildKit + Railpack (isolated Dockerless builds)\n                                       ├─ PostgreSQL (persistent app metadata)\n                                       └─ Deployed Containers (user application workloads)\n```\n\nFor a deep dive into decisions, failure states, and data paths, see the [Architecture Document](docs/architecture.md).\n\n## Features\n\n- **Dockerless Builds:** Uses **Railpack** and **BuildKit** to automatically detect runtimes and build images without requiring Dockerfiles.\n- **WebSocket Streaming:** Stream live build progress and runtime container logs directly to the dashboard or CLI.\n- **Dynamic Routing:** Automatic Caddy reverse-proxy routing to running app containers.\n- **Robust Restoration:** Automatically re-registers and restores application routes in Caddy after platform updates or server reboots.\n- **Secure Provisioning:** Includes an Ansible-driven setup with UFW, SSH hardening, kernel-level optimizations, and CIS-compliant configuration audits out of the box.\n\n## Requirements\n\n- **Operator Machine (Local):** macOS or Linux with network connectivity to target VPS.\n- **Remote Host (VPS):**\n  - Fresh install of Ubuntu (22.04 LTS or newer recommended) or Debian.\n  - SSH access with root or sudo permissions.\n  - Ports `80` (HTTP) and `443` (HTTPS) open.\n\n---\n\n## Local Setup (Development)\n\nTo spin up a local development cluster of the Appa Stack:\n\n```bash\n# Clone the repository\ngit clone https://github.com/theolujay/appa.git\ncd appa\n\n# Configure the local environment\ncp .env.example .env\n\n# Start dev services (Go API, Vite UI dev server, PostgreSQL, Caddy, BuildKit)\ndocker compose up --build -d\n```\n\nOpen [http://localhost](http://localhost) in your browser. For further environment setup, Makefile commands, and DB migrations, see [CONTRIBUTING.md](CONTRIBUTING.md).\n\n---\n\n## Production Setup \u0026 CLI Quick Start\n\nRemote VPS servers are managed from your local machine using the Appa CLI.\n\n### 1. Install Appa CLI\n\nInstall the `appa` CLI utility to `/usr/local/bin`:\n\n```bash\ncurl -fsSL https://appa.theolujay.dev/install.sh | sh -s -- -y\n```\n\n*Alternatively, compile from source:*\n```bash\nmake build/cli\n./bin/appa --help\n```\n\n### 2. Configure and Provision the Host\n\nRun these commands locally to configure your remote VPS instance:\n\n```bash\n# 1. Initialize local configuration file\nappa instance init my-server\n\n# 2. Configure target connection and SSH private key\nappa instance set-host my-server root@203.0.113.10 -i ~/.ssh/id_ed25519\n\n# 3. Perform automated preflight validation checks\nappa preflight my-server\n\n# 4. Provision VPS security hardening and deploy Appa Stack services\nappa setup my-server\n```\n\nOnce `appa setup` completes, the CLI will output the URL to access the React dashboard and configure your initial admin account.\n\n### 3. Remote Instance Operations\n\nYou can manage, inspect, and update your remote instance using the Appa CLI:\n\n- **Check status:** View the status and health of the remote Appa Stack services.\n  ```bash\n  appa status my-server\n  ```\n- **Stream logs:** Tail and stream service logs (with optional service filtering).\n  ```bash\n  # Tail all logs\n  appa logs my-server\n\n  # Filter by service (e.g., API)\n  appa logs my-server -s api\n  ```\n- **Apply configuration changes:** Update environment variables or SSH targets and re-apply settings idempotently.\n  ```bash\n  appa apply my-server\n  ```\n- **Restart or Upgrade:** Perform zero-downtime upgrades or restart services.\n  ```bash\n  appa restart my-server\n  appa upgrade my-server --version v0.1.2\n  ```\n\n---\n\n## Documentation Index\n\n- [Architecture Reference](docs/architecture.md) — Detailed diagram, invariants, and structural decisions.\n- [Ansible Reference](docs/ansible.md) — Information on security roles, Molecule tests, and Vagrant local setups.\n- [Project Roadmap](docs/roadmap.md) — Completed milestones and future features (including secrets encryption).\n- [Contributing Guide](CONTRIBUTING.md) — API routes, local development commands, and coding conventions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheolujay%2Fappa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftheolujay%2Fappa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftheolujay%2Fappa/lists"}