openship

(★ 11,162)

Self-hosted deployment platform

File Explorer

Showing a partial file list — download the zip above to see everything.

  • .bun-version
  • .dockerignore
  • .env.example
  • .gitignore
  • .nvmrc
  • .prettierrc
  • CHANGELOG.md
  • CONTRIBUTING.md
  • LICENSE
  • README.md
  • SECURITY.md
  • SECURITY_GUIDE.md
  • TODO.md

# Installation Guide

node
Prerequisites

Setup Steps

git clone https://github.com/oblien/openship.git

Clone the project source code.

cp .env.example .env

Copy the environment variables template file.

docker compose --env-file .env -f docker/docker-compose.yml up -d

Run the entire stack in the background using docker compose.

Key Commands

openship up --public-url https://openship.example.com

Install and start Openship as a background boot service.

openship deploy

Deploy the project in the current directory.

docker compose --env-file .env -f docker/docker-compose.yml up -d

Run docker compose containers in the background.

Create and configure the .env file with appropriate values before running.

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Showing a partial file list.

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

docker compose

View Details ▼

Run and manage multi container Docker applications.

docker compose ps

List all running containers:

docker compose up {{[-d|--detach]}}

Create and start all containers in the background using a `docker-compose.yml` file from the current directory:

docker compose up --build

Start all containers, rebuild if necessary:

🔍

git clone

View Details ▼

Clone an existing repository.

git clone {{remote_repository_location}} {{path/to/directory}}

Clone an existing repository into a new directory (the default directory is the repository name):

git clone --recursive {{remote_repository_location}}

Clone an existing repository and its submodules:

git clone {{[-n|--no-checkout]}} {{remote_repository_location}}

Clone only the `.git` directory of an existing repository:

// repository documentation