oblien/openship:README 來源編輯指南
根據 README、倉庫資料與授權整理 oblien/openship 的安裝與核驗路徑。
專案定位
oblien/openship 的 README 將專案描述為「Self-hosted deployment platform」。本文只整理倉庫可直接核對的內容,不把 star、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 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「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.。