openship 0.1.0 → 0.1.1

package/README.md

@@ -1,164 +1,360 @@
-<div align="center">
-  <h1>🚀 Openship</h1>
-  <p><strong>The open-source, self-hostable deployment platform.</strong></p>
-  <p>Deploy anywhere — from your own server to our managed cloud.</p>
+<h1 align="center">Openship</h1>
 
-  <br />
+<p align="center">
+  Deploy anything. Own everything.<br>
+  Push your code — build, configure, and deploy from one place.<br>
+  Use our cloud or connect your own servers.
+</p>
 
-  <a href="#quick-start">Quick Start</a> ·
-  <a href="#architecture">Architecture</a> ·
-  <a href="#self-hosting">Self-Hosting</a> ·
-  <a href="#cloud">Cloud</a> ·
-  <a href="#contributing">Contributing</a>
-</div>
+<p align="center">
+  Desktop-first. Open-source. Zero lock-in.
+</p>
+
+<p align="center">
+  <img src="docs/screenshots/screen.png" alt="Openship" width="800" />
+</p>
 
 ---
 
-## Quick Start
+## What Openship Is
 
-### Prerequisites
+Openship is a **desktop-first deployment platform with built-in CI/CD and full infrastructure control**.
 
-- [Node.js](https://nodejs.org/) >= 20
-- [pnpm](https://pnpm.io/) >= 9
-- [Docker](https://www.docker.com/) (for self-hosting or local development)
+It removes the gap between writing code and running it in production.
 
-### Development
+No pipelines to maintain.  
+No YAML to manage.  
+No platform lock-in.
 
-```bash
-# Clone the repo
-git clone https://github.com/openship/openship.git
-cd openship
+---
 
-# Install dependencies
-pnpm install
+## The Core Idea
 
-# Set up environment
-cp .env.example .env
+Most platforms run everything on your server:
 
-# Generate Prisma client
-pnpm db:generate
+- CI/CD pipelines
+- Build systems
+- Dashboards
+- Databases
+- Your apps
 
-# Push schema to local SQLite
-pnpm db:push
+→ Your production resources are shared with tooling.
 
-# Start all apps in dev mode
-pnpm dev
-```
+---
+
+### Openship
+
+**Your machine**
+- Desktop app (UI)
+- Build system (local by default)
+- Deployment control
+
+**Your server**
+- Production containers only
+
+→ No resource contention  
+→ Predictable performance  
+→ Clean architecture  
+
+---
+
+## Desktop-First Architecture
+
+Openship is not a hosted dashboard.
+
+It’s a **local control plane for your infrastructure**.
+
+- Builds run locally by default
+- Deployments are triggered instantly
+- Works with any VPS or private network
+- No dependency on a remote control layer
+
+Your server stays minimal:
+- No CI runners
+- No dashboards
+- No management services
+
+Only your apps.
+
+---
+
+## Built-in CI/CD (Without the Overhead)
+
+CI/CD is fully integrated — without pipelines to configure.
+
+- Deploy on every push
+- Preview environments per branch
+- Staging and production flows
+- Rollbacks built-in
+
+You can still use:
+- CLI workflows
+- External CI if needed
+- Server-side builds (optional)
+
+Default: simple, fast, local.
+
+---
+
+## Deploy Anywhere
+
+- Openship Cloud (managed)
+- Any VPS or bare metal
+- Any provider, any region
+- Multi-server deployments
+
+Same app, same flow — everywhere.
+
+---
+
+## Full Backend Support
+
+Run complete applications out of the box:
+
+- Databases (Postgres, MySQL, MongoDB)
+- Redis / caching
+- Background workers
+- WebSockets
+- APIs
+- Storage
+
+Provision and manage everything from the app.
+
+---
+
+## Any Stack
+
+If it builds, it ships.
+
+- Node.js, Bun, Deno
+- Python, Go, Rust
+- PHP, Ruby, Java, .NET
+- Docker (full control)
+- Monorepos supported
+
+No lock-in to a runtime.
+
+---
+
+## Domains & SSL
+
+- Automatic SSL (Let's Encrypt)
+- Wildcard domains
+- Unlimited domains
+- Auto-renewal
+
+No manual setup.
+
+---
+
+## The Desktop App
 
-This will start:
+Everything in one place:
 
-| App         | URL                     |
-| ----------- | ----------------------- |
-| Web         | http://localhost:3000    |
-| Dashboard   | http://localhost:3001    |
-| API         | http://localhost:4000    |
+- One-click deploys
+- Live build logs
+- Real-time metrics
+- Domain & DNS management
+- Database control
+- Backups & restore
+- Scaling controls
 
-### Self-Hosting with Docker
+Replaces:
+- CI dashboards
+- SSH workflows
+- Manual Docker setup
+
+---
+
+## Developer Interfaces
+
+### CLI
 
 ```bash
-cp .env.example .env
-docker compose up -d
+openship deploy
+openship logs --follow
+openship rollback
+openship domains
 ```
 
-That's it. Openship will be running at `http://localhost:3001`.
+---
+
+### REST API
+
+Automate everything:
+
+- Deployments
+- Projects
+- Domains
+- Logs
 
 ---
 
-## Architecture
+### MCP (AI / Agent Control)
 
-```
-openship/
-├── apps/
-│   ├── web/          # Next.js — Marketing site, landing page, docs, pricing
-│   ├── dashboard/    # Next.js — Authenticated deployment dashboard (Vercel-style)
-│   ├── api/          # Hono — Core API engine (auth, deployments, billing, webhooks)
-│   └── cli/          # TypeScript CLI — `openship deploy` from your terminal
-│
-├── packages/
-│   ├── adapters/     # Deployment adapters (DockerAdapter, OblienAdapter)
-│   ├── db/           # Prisma schema + client (SQLite local, Postgres cloud)
-│   ├── core/         # Shared types, constants, utilities, error classes
-│   └── ui/           # Shared React component library (Tailwind + shadcn style)
-│
-├── tooling/
-│   └── tsconfig/     # Shared TypeScript configurations
-│
-├── docker-compose.yml
-├── turbo.json
-└── pnpm-workspace.yaml
-```
+Expose deployment actions to external agents when needed.
 
-### API Modules
+---
+
+## Backups
 
-The API is organized into clean, independent modules:
+- Scheduled backups
+- Databases + volumes
+- One-click restore
+- Export anytime
 
-| Module         | Path                          | Purpose                                  |
-| -------------- | ----------------------------- | ---------------------------------------- |
-| **Auth**       | `modules/auth/`               | Registration, login, JWT, sessions       |
-| **Projects**   | `modules/projects/`           | CRUD for deployment projects             |
-| **Deployments**| `modules/deployments/`        | Build, deploy, rollback, logs            |
-| **Domains**    | `modules/domains/`            | Custom domains, DNS verification, SSL    |
-| **Billing**    | `modules/billing/`            | Plans, subscriptions, usage (cloud only) |
-| **Webhooks**   | `modules/webhooks/`           | GitHub/GitLab/Bitbucket push triggers    |
-| **Health**     | `modules/health/`             | Health check endpoint for load balancers |
+---
 
-### Adapter Pattern
+## Portability
 
-The **adapter pattern** is what makes Openship platform-agnostic:
+Move anywhere:
 
-- **`DockerAdapter`** — Self-hosted. Builds and runs containers on the host machine.
-- **`OblienAdapter`** — Cloud. Communicates with the Oblien infrastructure API.
+- Cloud ↔ self-host
+- VPS → VPS
+- Full export/import
 
-The `CLOUD_MODE` environment variable controls which adapter is active. For self-hosted installs, billing is completely disabled.
+No proprietary formats:
+- Standard Docker containers
+- Encrypted transfer via SSH
 
 ---
 
-## Self-Hosting
+## Built-in Mail Server
 
-Openship is designed to be self-hosted with a single `docker compose up`. The Docker adapter handles all builds and deployments locally on your machine.
+- Unlimited domains
+- Standard email auth (DKIM, SPF, DMARC)
+- No external providers required
 
-**Requirements:** Docker Engine, 2GB RAM minimum.
+---
+
+## Global CDN
+
+- Edge caching
+- Compression (HTTP/3, Brotli)
+- Instant cache purge
+
+Works with any deployment.
+
+---
+
+## Scaling
+
+### Cloud
+- Auto-scaling
+- Load balancing
+- Zero config
+
+### Self-hosted
+- Upgrade servers anytime
+- Move workloads without redeploy
+- Multi-node ready
 
 ---
 
-## Cloud
+## Architecture Comparison
 
-The hosted version at [openship.cloud](https://openship.cloud) adds:
+### Traditional Tools
 
-- Managed infrastructure via the Oblien adapter
-- Subscription billing (Stripe)
-- Usage metering (build minutes, bandwidth)
-- Team management and SSO
+Server runs:
+- CI/CD
+- Build system
+- Dashboard
+- Reverse proxy
+- Apps
+
+→ Resource contention  
+→ Complex setup  
 
 ---
 
-## Tech Stack
+### Openship
+
+**Local machine**
+- Builds
+- Control plane
+
+**Server**
+- Production containers only
+
+→ Maximum efficiency  
+→ Minimal overhead  
+
+---
+
+## Why Openship
+
+- Desktop-first deployment loop
+- Built-in CI/CD without pipeline overhead
+- No YAML or infra complexity
+- No server-side tooling overhead
+- Works on any Linux server
+- Fully open-source (AGPL-3)
+- No vendor lock-in
+
+---
+
+## Example Flow
+
+1. Connect your repo
+2. Connect a server (or use cloud)
+3. Click deploy
+
+Under the hood:
+- Build runs locally
+- Production container is shipped
+- App goes live
+
+---
+
+## Philosophy
+
+Infrastructure should be:
+
+- Local-first
+- Transparent
+- Portable
+- Fully owned
+
+Not hidden behind platforms.  
+Not tied to pricing models.  
+Not dependent on proprietary runtimes.
+
+---
+
+## Open Source
+
+- AGPL-3 licensed
+- Fully self-hostable
+- No usage limits
+- Community-driven
+
+---
+
+## Status
+
+Production-ready core.
 
-| Layer      | Technology                        |
-| ---------- | --------------------------------- |
-| Frontend   | Next.js 14, React 18, Tailwind    |
-| API        | Hono (edge-compatible)             |
-| Database   | Prisma (SQLite / PostgreSQL)       |
-| Queue      | BullMQ + Redis                     |
-| CLI        | Commander.js, TypeScript           |
-| Monorepo   | Turborepo + pnpm workspaces       |
-| Containers | Docker                             |
-| Billing    | Stripe                             |
+Planned:
+- Multi-node clusters
+- Load balancing UI
+- Private networking
+- Advanced monitoring
+- Visual CI/CD pipelines
 
 ---
 
-## Contributing
+## Get Started
 
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
+- Download the app
+- Connect your repo
+- Deploy in minutes
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b feat/amazing-feature`)
-3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
-4. Push to the branch (`git push origin feat/amazing-feature`)
-5. Open a Pull Request
+No lock-in.  
+No complexity.  
+Full control.
 
 ---
 
 ## License
 
-[MIT](LICENSE) — Free to use, self-host, and modify. Cloud/SaaS usage requires the AGPL license terms.
+AGPL-3

package/apps/api/Dockerfile

@@ -1,18 +1,16 @@
 # ─── Build stage ────────────────────────────────────────
-FROM node:20-alpine AS builder
-RUN corepack enable && corepack prepare pnpm@9.0.0 --activate
+FROM oven/bun:1 AS builder
 WORKDIR /app
 
-COPY pnpm-workspace.yaml pnpm-lock.yaml* package.json ./
-COPY tooling/ ./tooling/
+COPY package.json bun.lock pnpm-workspace.yaml ./
 COPY packages/ ./packages/
 COPY apps/api/ ./apps/api/
 
-RUN pnpm install --frozen-lockfile
-RUN pnpm run build --filter=openship-api...
+RUN bun install --frozen-lockfile
+RUN cd apps/api && bun run build
 
 # ─── Production stage ──────────────────────────────────
-FROM node:20-alpine AS runner
+FROM oven/bun:1-slim AS runner
 WORKDIR /app
 
 COPY --from=builder /app/apps/api/dist ./dist
@@ -21,4 +19,4 @@ COPY --from=builder /app/node_modules ./node_modules
 
 ENV NODE_ENV=production
 EXPOSE 4000
-CMD ["node", "dist/index.js"]
+CMD ["bun", "run", "dist/index.js"]

package/apps/api/package.json

@@ -1,10 +1,11 @@
 {
-  "name": "openship-api",
+  "name": "@repo/api",
   "version": "0.1.0",
   "private": true,
   "type": "module",
   "scripts": {
-    "dev": "tsx watch src/index.ts",
+    "dev": "node --env-file=.env --import tsx --watch src/index.ts",
+    "dev:saas": "PGLITE_DATA_DIR=$HOME/.openship/data-saas node --env-file=.env.saas --import tsx --watch src/index.ts",
     "build": "tsup src/index.ts --format esm --dts",
     "start": "node dist/index.js",
     "lint": "tsc --noEmit",
@@ -12,26 +13,29 @@
     "clean": "rm -rf dist .turbo node_modules"
   },
   "dependencies": {
-    "openship-core": "workspace:*",
-    "openship-db": "workspace:*",
-    "openship-adapters": "workspace:*",
-    "@hono/node-server": "^1.11.0",
-    "hono": "^4.4.0",
-    "zod": "^3.23.0",
-    "jsonwebtoken": "^9.0.0",
-    "bcryptjs": "^2.4.3",
-    "stripe": "^15.0.0",
-    "bullmq": "^5.7.0",
-    "ioredis": "^5.4.0",
-    "pino": "^9.1.0"
+    "@better-auth/drizzle-adapter": "^1.5.4",
+    "@hono/node-server": "^1.19.11",
+    "@hono/typebox-validator": "^0.3.0",
+    "@repo/adapters": "workspace:*",
+    "@repo/core": "workspace:*",
+    "@repo/db": "workspace:*",
+    "@sinclair/typebox": "^0.34.48",
+    "better-auth": "^1.5.4",
+    "bullmq": "^5.70.4",
+    "hono": "^4.12.5",
+    "ioredis": "^5.10.0",
+    "nodemailer": "^8.0.1",
+    "pino": "^10.3.1",
+    "stripe": "^20.4.0",
+    "yaml": "^2.8.2",
+    "zod": "^4.3.6"
   },
   "devDependencies": {
-    "openship-tsconfig": "workspace:*",
-    "@types/jsonwebtoken": "^9.0.0",
-    "@types/bcryptjs": "^2.4.0",
-    "tsx": "^4.11.0",
-    "tsup": "^8.1.0",
-    "vitest": "^1.6.0",
-    "typescript": "^5.4.0"
+    "@types/node": "^22.13.0",
+    "@types/nodemailer": "^7.0.11",
+    "tsup": "^8.5.1",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   }
 }

package/apps/api/src/app.ts

@@ -1,26 +1,69 @@
 import { Hono } from "hono";
 import { cors } from "hono/cors";
 import { logger } from "hono/logger";
+import { env, trustedOrigins } from "./config/env";
+import { errorHandler } from "./middleware/error-handler";
+import { rateLimiter } from "./middleware/rate-limiter";
+import { bootstrapPlatform } from "./lib/controller-helpers";
 
 import { authRoutes } from "./modules/auth/auth.routes";
 import { projectRoutes } from "./modules/projects/project.routes";
 import { deploymentRoutes } from "./modules/deployments/deployment.routes";
 import { domainRoutes } from "./modules/domains/domain.routes";
+import { analyticsRoutes } from "./modules/analytics/analytics.routes";
 import { billingRoutes } from "./modules/billing/billing.routes";
 import { webhookRoutes } from "./modules/webhooks/webhook.routes";
 import { healthRoutes } from "./modules/health/health.routes";
+import { githubRoutes } from "./modules/github";
+import { settingsRoutes } from "./modules/settings/settings.routes";
+
+/* ---------- Initialize platform (runtime + infra + system) ---------- */
+await bootstrapPlatform();
 
 export const app = new Hono();
 
 /* ---------- Global middleware ---------- */
+app.use(
+  "*",
+  cors({
+    origin: trustedOrigins,
+    credentials: true,
+  }),
+);
+app.use("*", errorHandler);
 app.use("*", logger());
-app.use("*", cors());
 
-/* ---------- Module routes ---------- */
+app.use("/api/auth/*", rateLimiter);
+
+/* ---------- Shared routes (self-hosted + cloud + desktop) ---------- */
 app.route("/api/health", healthRoutes);
 app.route("/api/auth", authRoutes);
 app.route("/api/projects", projectRoutes);
 app.route("/api/deployments", deploymentRoutes);
 app.route("/api/domains", domainRoutes);
-app.route("/api/billing", billingRoutes);
 app.route("/api/webhooks", webhookRoutes);
+app.route("/api/github", githubRoutes);
+app.route("/api/analytics", analyticsRoutes);
+app.route("/api/settings", settingsRoutes);
+
+/* ---------- Cloud-only routes (gated by CLOUD_MODE) ---------- */
+if (env.CLOUD_MODE) {
+  const { cloudSaasRoutes } = await import("./modules/cloud/cloud.routes");
+  app.route("/api/cloud", cloudSaasRoutes);
+  app.route("/api/billing", billingRoutes);
+} else {
+  /**
+   * System routes — filesystem browse, instance setup, user provisioning.
+   *
+   * Dynamic import: in cloud mode these modules are NEVER loaded into the
+   * process. The filesystem controller (node:fs), setup controller
+   * (admin user creation), and all their dependencies don't exist in
+   * the cloud runtime — not just "protected", but fully absent.
+   */
+  const { systemRoutes } = await import("./modules/system");
+  app.route("/api/system", systemRoutes);
+
+  /** Cloud account management — connect/disconnect to Openship Cloud */
+  const { cloudLocalRoutes } = await import("./modules/cloud/cloud.routes");
+  app.route("/api/cloud", cloudLocalRoutes);
+}