Skip to content

Latest commit

 

History

History
121 lines (98 loc) · 3.22 KB

README.md

File metadata and controls

121 lines (98 loc) · 3.22 KB
Raw

Project Logo

Hello World for StartOS

Hello World is a simple, minimal project that serves as a template for creating a service that runs on StartOS. This repository creates the s9pk package that is installed to run hello-world on StartOS. Learn more about service packaging in the Developer Docs.

Dependencies

Install the system dependencies below to build this project by following the instructions in the provided links. You can find instructions on how to set up the appropriate build environment in the Developer Docs.

Build environment

Prepare your StartOS build environment. In this example we are using Ubuntu 20.04.

  1. Install docker
curl -fsSL https://get.docker.com | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER
  1. Set buildx as the default builder
docker buildx install
docker buildx create --use
  1. Enable cross-arch emulated builds in docker
docker run --privileged --rm linuxkit/binfmt:v0.8
  1. Install yq
sudo snap install yq
  1. Install deno
sudo snap install deno
  1. Install essentials build packages
sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
  1. Install Rust
curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env
  1. Build and install start-sdk
git clone https://github.com/Start9Labs/start-os.git && \
 cd start-os && git submodule update --init --recursive && \
 make sdk

Initialize sdk & verify install

start-sdk init
start-sdk --version

Now you are ready to build the hello-world package!

Cloning

Clone the project locally:

git clone https://github.com/Start9Labs/hello-world-startos.git
cd hello-world-startos
git submodule update --init --recursive

Building

To build the hello-world package for all platforms using start-sdk, run the following command:

make

To build the hello-world package for a single platform using start-sdk, run:

# for amd64
make x86

or

# for arm64
make arm

Installing (on StartOS)

Run the following commands to determine successful install:

ℹ️ Change server-name.local to your Start9 server address

start-cli auth login
# Enter your StartOS password
start-cli --host https://server-name.local package install hello-world.s9pk

If you already have your start-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the hello-world.s9pk using Sideload Service under the System > Manage section.

Verify Install

Go to your StartOS Services page, select Hello World, configure and start the service. Then, verify its interfaces are accessible.

Done!