Install Now
How to install oblien/openship. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
oblien/openship Installation Guide
How to install oblien/openship. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for oblien/openship. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i oblien/openshipor
Install via npx
npx @hexmos/ipm i oblien/openshipPrerequisites
Node.js
runtimenpm
package managerDocker
runtimeVersion: required for Docker Compose installation
git
version controlManual Installation Methods
Manual installation instructions. How to install from GitHub source.
NPM Package Manager (Global Install)
npm i -g openship
openship upcURL Script (Global Install)
curl -fsSL https://get.openship.io | sh
openship upDocker Compose
git clone https://github.com/oblien/openship.git
cd openship
cp .env.example .env
docker compose up -dDesktop Application (macOS/Windows/Linux)
openship installPost Installation Steps
- openship open (opens the dashboard)
- openship stop (stops the service)
- openship up --foreground (one-off attached run)
- cd your-project && openship init && openship deploy (to deploy a project)