Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Quick Start

This guide walks you through creating your own service package repository from the Hello World template, building it, and installing it on StartOS.

Note

Ensure you have completed every step of Environment Setup before beginning.

Create Your Repository

  1. Navigate to the Hello World Template on GitHub.

  2. In the top right, click “Use this template > Create new repository”.

  3. Name your repository using the convention <service-name>-startos (e.g., nextcloud-startos).

  4. Click “Create Repository”.

  5. Clone your new repository:

    git clone https://github.com/YOUR-USERNAME/YOUR-REPO.git
    cd YOUR-REPO
    

Build

Install dependencies and build the package:

npm install
make

This generates a hello-world.s9pk file in the project root.

Install to StartOS

Option 1: Sideload via UI

Open the Sideload tab and upload the .s9pk.

Option 2: Direct Install (Local Network)

See Installation.

Next Steps

With Hello World running on your server, explore the rest of this packaging guide to learn how to build your own service.