eliott/Olares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rebrand docs content for beOS Pro

Browse Source
This commit is contained in:
Eliott van Nuffel
2026-03-09 10:19:35 +01:00
parent 150f4a8ef4
commit d4e933688d
616 changed files with 6294 additions and 6294 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/developer/develop/tutorial/assets.md
View File

@@ -1,26 +1,26 @@
---
description: Learn how to prepare and upload icons, feature image, and promotional images for your Olares apps.
description: Learn how to prepare and upload icons, feature image, and promotional images for your beOS Pro apps.
---
# Add icons, feature image, and promotional images
A great-looking app needs high-quality assets. This guide covers the specifications for your app's icon, feature image, and screenshots, and how to upload them to Olares.
A great-looking app needs high-quality assets. This guide covers the specifications for your app's icon, feature image, and screenshots, and how to upload them to beOS Pro.
## Asset specifications
Before uploading, ensure your images are in the correct format.
| Type | Format | Max size | Dimensions (px) | Description |
|:----------------------|:----------------|:------------|:----------------|:----------------------------------------------------------------------------------------------------------------------|
| **App icon** | PNG, WEBP | 512 KB | 256x256 | Your app's most common visual symbol, used on the Olares desktop and throughout the system. |
| **Feature image** | JPEG, PNG, WEBP | 8 MB | 1440x900 | Displayed on your app's page in **Market** > **My Olares**. |
| **App icon** | PNG, WEBP | 512 KB | 256x256 | Your app's most common visual symbol, used on the beOS Pro desktop and throughout the system. |
| **Feature image** | JPEG, PNG, WEBP | 8 MB | 1440x900 | Displayed on your app's page in **Market** > **My beOS Pro**. |
| **Promotional image** | JPEG, PNG, WEBP | 8 MB (each) | 1440x900 | If you plan to submit your app to the public Market, you must upload at least two. You can upload a maximum of eight. |
## Upload and link assets
1. Navigate to the [Olares Market Image Hosting service](https://imghost.olares.com/).
1. Navigate to the [beOS Pro Market Image Hosting service](https://imghost.beos.local/).
2. Select the type of asset you are uploading (e.g., Icon).
3. Drag and drop your prepared file into the upload area, or click to select it.
4. Click the image thumbnail to make simple edits if necessary.
5. When you are ready, click **Upload**.
6. After the upload, the service will provide a direct URL for the image. Click <span class="material-symbols-outlined">content_copy</span> to copy the URL to your clipboard.
7. Open your app project in **Studio**.
8. Paste the URL into the corresponding field in your `OlaresManifest.yaml` file.
8. Paste the URL into the corresponding field in your `beOS ProManifest.yaml` file.

24
docs/developer/develop/tutorial/deploy.md
View File

@@ -1,9 +1,9 @@
---
outline: [2, 3]
description: Deploy a single-container Docker app to Olares using Studio.
description: Deploy a single-container Docker app to beOS Pro using Studio.
---
# Deploy an app from Docker image
This guide explains how to deploy a single-container Docker app to Olares using Studio.
This guide explains how to deploy a single-container Docker app to beOS Pro using Studio.
:::info For single-container apps
This method supports apps that run from a single container image.
@@ -13,8 +13,8 @@ Studio-created deployments are best suited for development, testing, or temporar
:::
## Prerequisites
- Olares version 1.12.2 or later.
- A container image for the app exists and is accessible from the Olares host.
- beOS Pro version 1.12.2 or later.
- A container image for the app exists and is accessible from the beOS Pro host.
- The app's `docker run` command or `docker-compose.yaml` is available to reference configuration (ports, environment variables, volumes).
## Create and configure your app
@@ -54,8 +54,8 @@ services:
1. Open Studio and select **Create a new application**.
2. Enter an **App name**, for example: `wallos`, and click **Confirm**.
3. Select **Port your own container to Olares**.
![Port your own container to Olares](/images/manual/olares/studio-port-your-own-container-to-olares.png#bordered)
3. Select **Port your own container to beOS Pro**.
![Port your own container to beOS Pro](/images/manual/olares/studio-port-your-own-container-to-olares.png#bordered)
### Configure image, port, and instance spec
These fields define the app's core components. You can find this information as the main image name and the `-p` flag in a `docker run` command, or under the `image:` and `ports:` keys in a `docker-compose.yaml` file.
@@ -79,10 +79,10 @@ Environment variables are used to pass configuration settings to your app. In th
![Add environment variables](/images/manual/olares/studio-add-environment-variables.png#bordered)
### Add storage volumes
Volumes connect storage on your Olares device to a path inside the app's container, which is essential for saving data permanently. These are defined using the `-v` flag or in the `volumes:` section.
Volumes connect storage on your beOS Pro device to a path inside the app's container, which is essential for saving data permanently. These are defined using the `-v` flag or in the `volumes:` section.
:::info Host path options
The host path is where Olares stores the data, and the mount path is the path inside the container. Studio provides three managed host path prefixes:
The host path is where beOS Pro stores the data, and the mount path is the path inside the container. Studio provides three managed host path prefixes:
- `/app/data`: App data directory. Data can be accessed across nodes and is not deleted when the app is uninstalled. Appears under `/Data/studio` in Files.
- `/app/cache`: App cache directory. Data is stored in the node's local disk and is deleted when the app is uninstalled. Appears under `/Cache/<device-name>/studio` in Files.
@@ -154,13 +154,13 @@ When enabled, Studio provides dynamic variables. You must use these variables in
Apps deployed from Studio include a `-dev` suffix in the title to distinguish them from Market installations.
![Check deployed app](/images/manual/olares/studio-app-with-dev-suffix.png#bordered)
You can click on files like `OlaresManifest.yaml` to review and make changes. For example, to change the app's display name and logo:
You can click on files like `beOS ProManifest.yaml` to review and make changes. For example, to change the app's display name and logo:
1. Click **<span class="material-symbols-outlined">box_edit</span>Edit** in the top-right to open the editor.
2. Click `OlaresManifest.yaml` to view the content.
2. Click `beOS ProManifest.yaml` to view the content.
3. Change the `title` field under `entrance` and `metadata`. For example, change `wallos` to `Wallos`.
4. Replace the default icon image address under `entrance` and `metadata`.
![Edit `OlaresManifest.yaml`](/images/manual/olares/studio-edit-olaresmanifest1.png#bordered)
![Edit `beOS ProManifest.yaml`](/images/manual/olares/studio-edit-olaresmanifest1.png#bordered)
5. Click <span class="material-symbols-outlined">save</span> in the top-right to save changes.
6. Click **Apply** to reinstall with the updated package.
@@ -174,7 +174,7 @@ You can click on files like `OlaresManifest.yaml` to review and make changes. Fo
If you no longer need the app, you can remove it.
1. Click <span class="material-symbols-outlined">more_vert</span> in the top-right corner.
2. You can choose to:
- **Uninstall**: Removes the running app from Olares, but keeps the project in Studio so you can continue editing the package.
- **Uninstall**: Removes the running app from beOS Pro, but keeps the project in Studio so you can continue editing the package.
- **Delete**: Uninstalls the app and removes the project from Studio. This action is irreversible.
## Troubleshoot a deployment

20
docs/developer/develop/tutorial/develop.md
View File

@@ -3,19 +3,19 @@ outline: [2, 3]
description: Learn how to use Studio to set up a dev container, access it via VS Code, and configure port forwarding.
---
# Develop in a dev container
Olares Studio allows you to spin up a pre-configured dev container to write and debug code (such as Node.js scripts or CUDA programs) without managing local infrastructure. This provides an isolated environment identical to the production runtime.
beOS Pro Studio allows you to spin up a pre-configured dev container to write and debug code (such as Node.js scripts or CUDA programs) without managing local infrastructure. This provides an isolated environment identical to the production runtime.
The following guide shows the development and setup workflow using a Node.js project as an example.
## Prerequisite
- Olares version 1.12.2 or later.
- beOS Pro version 1.12.2 or later.
## 1. Initialize the container
To start coding, you must provision the container resources and select your runtime environment.
1. Open Studio and select **Create a new application**.
2. Enter an **App name**, for example: `My Web`, and click **Confirm**.
3. Select **Coding on Olares** as the creation method.
![Coding on Olares](/images/manual/olares/studio-coding-on-olares.png#bordered)
3. Select **Coding on beOS Pro** as the creation method.
![Coding on beOS Pro](/images/manual/olares/studio-coding-on-olares.png#bordered)
4. Configure the **Dev Env**:
@@ -110,7 +110,7 @@ This example demonstrates creating a basic web page manually.
</head>
<body>
<h1>Hello World</h1>
<h1>Hello Olares</h1>
<h1>Hello beOS Pro</h1>
</body>
</html>
```
@@ -125,18 +125,18 @@ This example demonstrates creating a basic web page manually.
## 4. Configure port forwarding
If you need to expose additional ports after the container is created (e.g., adding port `8081`), you must manually edit the container configuration manifests.
:::tip
You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.yaml` to change the port number.
You can follow the same steps to modify `beOS ProManifest.yaml` and `deployment.yaml` to change the port number.
:::
### Modify configuration manifests
1. In Studio, click **<span class="material-symbols-outlined">box_edit</span>Edit** in the top-right to open the editor.
2. Edit `OlaresManifest.yaml`.
2. Edit `beOS ProManifest.yaml`.
a. Append the new port to the `entrances` list:
```yaml
entrances:
- authLevel: private
host: myweb
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
invisible: true
name: myweb-dev-8080
openMethod: ""
@@ -146,7 +146,7 @@ You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.ya
# Add the following
- authLevel: private
host: myweb # Must match Service metadata name
icon: https://app.cdn.olares.com/appstore/default/defaulticon.webp
icon: https://app.cdn.beos.local/appstore/default/defaulticon.webp
invisible: true
name: myweb-dev-8081 # Unique identifier
openMethod: ""
@@ -162,7 +162,7 @@ You can follow the same steps to modify `OlaresManifest.yaml` and `deployment.ya
annotations:
applications.app.bytetrade.io/default-thirdlevel-domains:
'[{"appName":"myweb","entranceName":"myweb-dev-8080"},{"appName":"myweb","entranceName":"myweb-dev-8081"}]'
# entranceName must match the name used in OlaresManifest.yaml
# entranceName must match the name used in beOS ProManifest.yaml
```
b. Update the `studio-expose-ports` annotation under `spec` > `template` > `metadata`:
```yaml

8
docs/developer/develop/tutorial/index.md
View File

@@ -1,10 +1,10 @@
---
description: Get started with Studio to deploy Docker-based apps, develop new apps, package and upload locally, and manage assets on your Olares device.
description: Get started with Studio to deploy Docker-based apps, develop new apps, package and upload locally, and manage assets on your beOS Pro device.
---
# Deploy and develop apps in Olares
# Deploy and develop apps in beOS Pro
Studio provides a real Olares environment for building, porting, and testing apps when cloud features and the sandbox system are hard to simulate locally. With Studio you can:
- Create a new Olares app in an online development container.
Studio provides a real beOS Pro environment for building, porting, and testing apps when cloud features and the sandbox system are hard to simulate locally. With Studio you can:
- Create a new beOS Pro app in an online development container.
- Port an existing app, adjust its configurations, and test the installation flow.
- Package your app into a chart and download it when your app is ready.

14
docs/developer/develop/tutorial/note/create.md
View File

@@ -6,15 +6,15 @@ outline: [2, 3]
## Install and Launch Studio
1. Install [Studio](https://market.olares.com/app/studio) from the Olares Market.
2. Find the Studio icon in the launcher panel on the Olares Desktop.
1. Install [Studio](https://market.beos.local/app/studio) from the beOS Pro Market.
2. Find the Studio icon in the launcher panel on the beOS Pro Desktop.
3. Click on the icon to launch the application.
![main screen](/images/developer/develop/tutorial/create/home.jpg)
## Create Your App
Click the **Create a new application** to create a blank Olares application from a template.
Click the **Create a new application** to create a blank beOS Pro application from a template.
- In the **App Name** field, enter your application name.
- Set the **APP type** to **app**.
@@ -25,7 +25,7 @@ Click the **Create a new application** to create a blank Olares application from
## Setup App Config
After creating the application, you can see the Olares Application Chart files generated by Studio under the **Files** Tab. You can add, delete, or rename various configuration files as needed.
After creating the application, you can see the beOS Pro Application Chart files generated by Studio under the **Files** Tab. You can add, delete, or rename various configuration files as needed.
![upload icon](/images/developer/develop/tutorial/create/add-file.jpg)
@@ -33,9 +33,9 @@ After creating the application, you can see the Olares Application Chart files g
The `Chart.yaml` file is a required file in the Helm Chart specification. It contains the application's `Name` and `Chart Version`. You can [learn more here](https://helm.sh/docs/topics/charts/). For now, we're not going to change the default `Chart.yaml` yet.
### OlaresManifest.yaml
### beOS ProManifest.yaml
In the `OlaresManifest.yaml `file, you can change many configurations. This includes but is not limited to:
In the `beOS ProManifest.yaml `file, you can change many configurations. This includes but is not limited to:
- Changing the app's title, icon, and other details
- Adding system `middleware`
@@ -87,7 +87,7 @@ These parameters should not be hardcoded, they must reference the variables pass
#### Adding [Access Permissions to the File System](../../package/manifest.md#permission)
To read and save files in the Olares system, we need to configure Access Permissions for certain file directories. These directories can be specified in the `Permissions` section of the `OlaresManifest.yaml` file:
To read and save files in the beOS Pro system, we need to configure Access Permissions for certain file directories. These directories can be specified in the `Permissions` section of the `beOS ProManifest.yaml` file:
- `appData`: This applies for independent cloud storage space for the app.
- `appCache`: This applies for local disk data cache space, usually on an SSD disk, for the app.

2
docs/developer/develop/tutorial/note/frontend.md
View File

@@ -50,7 +50,7 @@ After cloning the code, if you are working on a Node project, you might need to
nginx -s reload
```
## Run Dev Mode
After completing the **Nginx** configuration, you can start your frontend program in dev mode and preview your APP in Olares.
After completing the **Nginx** configuration, you can start your frontend program in dev mode and preview your APP in beOS Pro.
```sh
npm run dev

8
docs/developer/develop/tutorial/note/index.md
View File

@@ -1,13 +1,13 @@
# Create Your First Olares App
# Create Your First beOS Pro App
You can learn how to develop an Olares app using Studio through this tutorial.
You can learn how to develop an beOS Pro app using Studio through this tutorial.
The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-app-demo) tool. It demonstrates how to start from scratch and develop a complete Olares App.
The tutorial shows how to make a simple [Note](https://github.com/beclab/olares-app-demo) tool. It demonstrates how to start from scratch and develop a complete beOS Pro App.
The tutorial includes three parts:
1. [Create an App](./create.md)<br>
This section provides a step-by-step guide on how to create an Olares App and set up the initial development environment.
This section provides a step-by-step guide on how to create an beOS Pro App and set up the initial development environment.
2. [Backend Development](./backend.md)<br>
In this section, you'll learn how to use Studio's IDE to develop the backend programs in `Golang` and provide API interfaces for the frontend.

8
docs/developer/develop/tutorial/package-upload.md
View File

@@ -1,10 +1,10 @@
---
description: Download an app package from Studio and install it in the Olares Market for stable, long-term use.
description: Download an app package from Studio and install it in the beOS Pro Market for stable, long-term use.
---
# Package and upload your app to Market
Apps created in Studio are ideal for development and testing. For stable, long-term use, it is best to install them through the Olares Market.
Apps created in Studio are ideal for development and testing. For stable, long-term use, it is best to install them through the beOS Pro Market.
## Download the App package from Studio
@@ -17,11 +17,11 @@ After confirming that your app works as expected, you can download its complete
## Install the App via the Market
1. Open the **Market** app.
2. Navigate to the **My Olares** section and select **Upload custom chart**.
2. Navigate to the **My beOS Pro** section and select **Upload custom chart**.
3. Select the app package file (`.tgz`) you downloaded from Studio. Wait for the upload to complete.
4. A pop-up will appear confirming the app was successfully added. Click **Install now**.
![Install custom chart](/images/manual/olares/studio-custom-install.png#bordered)
Once finished, you can click **Open** to launch it.
All custom-installed apps will appear under the **My Olares** > **Upload** tab.
All custom-installed apps will appear under the **My beOS Pro** > **Upload** tab.