Hello World is a simple, minimal project that serves as a template for creating a service that runs on embassyOS. This repository creates the s9pk package that is installed to run hello-world on embassyOS. Learn more about service packaging in the Developer Docs.
Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging documentation.
Prepare your embassyOS build environment. In this example we are using Ubuntu 20.04.
- Install docker
curl -fsSL https://get.docker.com | bash
sudo usermod -aG docker "$USER"
exec sudo su -l $USER
- Set buildx as the default builder
docker buildx install
docker buildx create --use
- Enable cross-arch emulated builds in docker
docker run --privileged --rm linuxkit/binfmt:v0.8
- Install yq
sudo snap install yq
- Install deno
sudo snap install deno
- Install essentials build packages
sudo apt-get install -y build-essential openssl libssl-dev libc6-dev clang libclang-dev ca-certificates
- Install Rust
curl https://sh.rustup.rs -sSf | sh
# Choose nr 1 (default install)
source $HOME/.cargo/env
- Build and install embassy-sdk
cd ~/ && git clone --recursive https://github.com/Start9Labs/embassy-os.git
cd embassy-os/backend/
./install-sdk.sh
embassy-sdk init
Now you are ready to build the hello-world package!
Clone the project locally:
git clone https://github.com/Start9Labs/hello-world-wrapper.git
cd hello-world-wrapper
git submodule update --init --recursive
To build the hello-world package for all platforms using embassy-sdk version >=0.3.3, run the following command:
make
To build the hello-world package for a single platform using embassy-sdk version <=0.3.2, run:
# for amd64
make ARCH=x86_64
or
# for arm64
make ARCH=aarch64
Run the following commands to determine successful install:
ℹ️ Change embassy-server-name.local to your Embassy address
embassy-cli auth login
# Enter your embassy password
embassy-cli --host https://embassy-server-name.local package install hello-world.s9pk
If you already have your embassy-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.
Go to your Embassy Services page, select Hello World, configure and start the service. Then, verify its interfaces are accessible.
Done!