Retropex/DeepSea-startos
1
0
Fork 0
mirror of https://github.com/Retropex/DeepSea-startos.git synced 2025-05-12 13:40:41 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Léo Haf 2025-04-25 15:48:36 +02:00
parent 659e8dd909
commit 1da8414be0
Signed by: Retropex
GPG Key ID: F5073C4F4882FFFC
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,9 +2,9 @@
<img src="icon.png" alt="Project Logo" width="21%"> <img src="icon.png" alt="Project Logo" width="21%">
</p> </p>
# Hello World for StartOS # DeepSea dashboard 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](https://github.com/Start9Labs/start-os/). Learn more about service packaging in the [Developer Docs](https://start9.com/latest/developer-docs/). [DeepSea dashboard](https://github.com/Djobleezy/DeepSea-Dashboard) is an alternative dashboard for [OCEAN](https://ocean.xyz).
## Dependencies ## Dependencies
@ -63,27 +63,27 @@ Initialize sdk & verify install
start-sdk init start-sdk init
start-sdk --version start-sdk --version
``` ```
Now you are ready to build the `hello-world` package! Now you are ready to build the `deepsea-dashboard` package!
## Cloning ## Cloning
Clone the project locally: Clone the project locally:
``` ```
git clone https://github.com/Start9Labs/hello-world-startos.git git clone https://github.com/Retropex/DeepSea-startos.git
cd hello-world-startos cd DeepSea-startos
git submodule update --init --recursive git submodule update --init --recursive
``` ```
## Building ## Building
To build the `hello-world` package for all platforms using start-sdk, run the following command: To build the `deepsea-dashboard` package for all platforms using start-sdk, run the following command:
``` ```
make make
``` ```
To build the `hello-world` package for a single platform using start-sdk, run: To build the `deepsea-dashboard` package for a single platform using start-sdk, run:
``` ```
# for amd64 # for amd64
@ -103,7 +103,7 @@ Run the following commands to determine successful install:
``` ```
start-cli auth login start-cli auth login
# Enter your StartOS password # Enter your StartOS password
start-cli --host https://server-name.local package install hello-world.s9pk start-cli --host https://server-name.local package install deepsea-dashboard.s9pk
``` ```
If you already have your `start-cli` config file setup with a default `host`, you can install simply by running: If you already have your `start-cli` config file setup with a default `host`, you can install simply by running:
@ -112,10 +112,10 @@ If you already have your `start-cli` config file setup with a default `host`, yo
make install make install
``` ```
> **Tip:** You can also install the hello-world.s9pk using **Sideload Service** under the **System > Manage** section. > **Tip:** You can also install the deepsea-dashboard.s9pk using **Sideload Service** under the **System > Manage** section.
### Verify Install ### Verify Install
Go to your StartOS Services page, select **Hello World**, configure and start the service. Then, verify its interfaces are accessible. Go to your StartOS Services page, select **DeepSea Dashboard**, configure and start the service. Then, verify its interfaces are accessible.
**Done!** **Done!**