Hysen Labsoblien/openship：README 来源编辑指南
基于 README、仓库元数据和许可证整理 oblien/openship 的安装与核验路径。
项目定位
oblien/openship 的 README 将项目描述为"Self-hosted deployment platform"。本文只整理仓库能直接核验的内容，不把星标、Fork 或宣传语当成质量证明。README 在"README"下的说明是：Open-source, self-hostable deployment platform with built-in CI/CD. Point it at a repo , it builds, ships, routes, and TLS-terminates your app. Drive it from a desktop app, web dashboard, or CLI.。这给出的首先是项目边界，而不是已经完成的生产验证。
适用场景
从 README 的"Team / always-on , self-hosted server"和相关条目看，读者可以先判断它是否解决自己的具体问题：Everywhere else → bare mode (macOS, Windows, or Linux without Docker). A single lightweight process with an embedded database , an always-on control plane that deploys apps out to a server (SSH) or Cloud, like the desktop app but always on。如果你的目标与这段说明不一致，就不应仅凭项目热度采用它。这里保留原项目名、命令和组件名，方便回到一手来源核对。 README 还列出了另一条可核对的信息：On Linux with Docker → Compose mode (the default). Brings up the full stack , Postgres, Redis, API, dashboard, and a containerized OpenResty edge on :80/:443 , from published images.。这类原文条目可以帮助读者设计试运行步骤，但不能代替自己的环境测试。
工作方式
README 把工作方式分散写在"Quick Start"等段落中。可确认的线索包括：| If you're… | Run Openship as | Where your apps run | |---|---|---| | Solo, one machine, no ops | Desktop app | A server you connect over SSH, or Openship Cloud | | A team , or you want push-to-deploy / to host apps on your own box |。这篇整理没有把未写出的架构、性能或安全边界补成结论；真正的运行链仍应结合仓库目录、配置文件和版本标签检查。
安装与第一次运行
第一次安装应从 README 给出的入口开始。当前可复核的命令是： curl -fsSL https://get.openship.io | sh # install (or: npm i -g openship) openship # guided setup, then control panel 如果仓库没有提供命令，本文不会替它编造安装步骤，而是建议先打开 README 的"Solo , desktop app"部分，确认系统依赖、默认端口和首次初始化动作。
配置与日常使用
日常使用的细节取决于项目实际文档。README 的"Quick Start"段落提到：> [!TIP] > Solo? Use the desktop app. It runs Openship's control plane on your own machine only while the app is open , nothing is left running on an always-on server, nothing is exposed publicly.。对于配置文件、环境变量、权限和数据目录，当前稿只记录来源明确的部分；未写明的默认值必须在测试环境中验证，并保留可回滚的配置副本。 同一部分还提到：Desktop app , full GUI, real-time logs, one-click everything. Best for solo.。