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

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