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

8
docs/developer/develop/advanced/cli/olares-change-ip.md
View File

@@ -1,10 +1,10 @@
# `olares change-ip`
:::warning When manually updating IP address is required
When Olares is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause Olares to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that Olares can route traffic correctly.
When beOS Pro is deployed _inside_ a virtualized environment, such as macOS (via Minikube) or Windows (via WSL), a change in the host system's IP address (e.g., due to switching Wi-Fi networks) may cause beOS Pro to become inaccessible. This happens because the NAT gateway and DNS configuration no longer match the new IP. In such cases, you need to manually update the IP address to ensure that beOS Pro can route traffic correctly.
:::
## Synopsis
Change the local IP address for all Olares components.
Change the local IP address for all beOS Pro components.
```bash
olares-cli olares change-ip [option]
@@ -14,11 +14,11 @@ olares-cli olares change-ip [option]
| Name | Shorthand | Usage |
|------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--distribution` | `-d` | Sets the WSL distribution name. Only applicable on Windows. <br> Defaults to `Ubuntu`. |
| `--help` | `-h` | Displays help information. |
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
## Examples
- For macOS:

32
docs/developer/develop/advanced/cli/olares-cli.md
View File

@@ -1,25 +1,25 @@
---
outline: [2, 3]
---
# Olares CLI
# beOS Pro CLI
Olares provides Olares CLI, a command-line tool for developers and system administrators to customize or troubleshoot the Olares installation process.
beOS Pro provides beOS Pro CLI, a command-line tool for developers and system administrators to customize or troubleshoot the beOS Pro installation process.
The recommended [one-liner installation command](../../../../manual/get-started/install-olares.md) retrieves a shell script from https://olares.sh/ that downloads and installs Olares CLI. Once installed, the CLI orchestrates the remainder of the setup.
The recommended [one-liner installation command](../../../../manual/get-started/install-olares.md) retrieves a shell script from https://olares.sh/ that downloads and installs beOS Pro CLI. Once installed, the CLI orchestrates the remainder of the setup.
In general, Olares CLI manages installation through three main phases:
1. **Download**: Olares CLI fetches the necessary components.
2. **Prepare**: Olares CLI prepares the environment for installation.
3. **Install**: Olares CLI installs the core services of Olares.
In general, beOS Pro CLI manages installation through three main phases:
1. **Download**: beOS Pro CLI fetches the necessary components.
2. **Prepare**: beOS Pro CLI prepares the environment for installation.
3. **Install**: beOS Pro CLI installs the core services of beOS Pro.
This page explains the Olares CLI syntax and describes the command operations.
This page explains the beOS Pro CLI syntax and describes the command operations.
:::info Root privileges required
Most `olares-cli` commands require root privileges. Use the root user or prepend commands with `sudo`.
:::
## Syntax
The Olares CLI uses the following syntax:
The beOS Pro CLI uses the following syntax:
> `olares-cli command [subcommand] [option]`
@@ -28,7 +28,7 @@ where
- `subcommand`: Further specifies the task of `command`. For example, `wizard` or `component`.
- `option`: Optional arguments that modify the behavior of the `command`. Options include flags and options with arguments.
Olares CLI allows you to temporarily override certain Olares default settings. Each option applies only to the command in which it is used.
beOS Pro CLI allows you to temporarily override certain beOS Pro default settings. Each option applies only to the command in which it is used.
For example, if you use the `--base-dir` option with `olares-cli olares download wizard`, it will only affect the wizard downloading process and will not change the base directory for other commands, such as during the "install" phase.
@@ -38,13 +38,13 @@ To get detailed help for any command, run `olares-cli help`.
| Operation | Syntax | Description |
|--------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------|
| `olares info` | `olares-cli olares info [option]` | Displays general information about the downloaded Olares OS. |
| `olares info` | `olares-cli olares info [option]` | Displays general information about the downloaded beOS Pro. |
| `olares download` | `olares-cli olares download [subcommand] [option]` | Downloads specific resources. |
| `olares prepare` | `olares-cli olares prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of Olares. |
| `olares install` | `olares-cli olares install [option]` | Deploys system-level and user-level components of Olares. |
| `olares change-ip` | `olares-cli olares change-ip [option]` | Changes the IP address of the Olares OS. |
| `olares release` | `olares-cli olares release [option]` | Packages Olares installation resources for distribution or deployment. |
| `olares uninstall` | `olares-cli olares uninstall [option]` | Uninstalls Olares completely, or roll back the installation to a specific phase. |
| `olares prepare` | `olares-cli olares prepare [option]` | Prepares the environment for the installation process, including setting up essential services and configurations of beOS Pro. |
| `olares install` | `olares-cli olares install [option]` | Deploys system-level and user-level components of beOS Pro. |
| `olares change-ip` | `olares-cli olares change-ip [option]` | Changes the IP address of the beOS Pro. |
| `olares release` | `olares-cli olares release [option]` | Packages beOS Pro installation resources for distribution or deployment. |
| `olares uninstall` | `olares-cli olares uninstall [option]` | Uninstalls beOS Pro completely, or roll back the installation to a specific phase. |

14
docs/developer/develop/advanced/cli/olares-download.md
View File

@@ -1,7 +1,7 @@
# `olares download`
## Synopsis
The `olares download` command downloads the necessary packages and components required to install Olares on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
The `olares download` command downloads the necessary packages and components required to install beOS Pro on your local machine. It supports downloading components, checking the status of installation packages, and fetching the manifest file.
```bash
olares-cli olares download [subcommand] [option]
@@ -11,26 +11,26 @@ olares-cli olares download [subcommand] [option]
| Name | Shorthand | Usage | Example |
|-------------|-----------|-------------------------------------------------------|----------------------------------------|
| `check` | | Checks the status of the Olares installation package. | `olares-cli olares download check` |
| `component` | `c` | Downloads Olares components. | `olares-cli olares download component` |
| `check` | | Checks the status of the beOS Pro installation package. | `olares-cli olares download check` |
| `component` | `c` | Downloads beOS Pro components. | `olares-cli olares download component` |
| `wizard` | `w` | Downloads the manifest file. | `olares-cli olares download wizard` |
## Options
| Name | Shorthand | Usage |
|----------------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--download-cdn-url` | | Sets the CDN accelerated download URL in the format `https://example.cdn.com`. <br>If not provided, the default URL will be used. |
| `--help` | `-h` | Displays help information. |
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
## Examples
```bash
# Specifies the base directory where all downloaded components will be stored.
olares-cli olares download component -b /custom/path
# Specifies a CDN-accelerated URL for downloading Olares components.
# Specifies a CDN-accelerated URL for downloading beOS Pro components.
olares-cli olares download component --download-cdn-url https://my.cdn.com
# Specifies the Kubernetes type for the installation.
@@ -39,7 +39,7 @@ olares-cli olares download component --kube k8s
# Sets the path to the package manifest file.
olares-cli olares download component --manifest /custom/path/manifest.json
# Specifies the version of Olares packages and components to download.
# Specifies the version of beOS Pro packages and components to download.
olares-cli olares download component -v 1.11.0
```

2
docs/developer/develop/advanced/cli/olares-info.md
View File

@@ -1,7 +1,7 @@
# `olares info`
## Synopsis
The `olares info` command displays general information about the installed Olares version.
The `olares info` command displays general information about the installed beOS Pro version.
```bash
olares-cli olares info

6
docs/developer/develop/advanced/cli/olares-install.md
View File

@@ -1,7 +1,7 @@
# `olares install`
## Synopsis
The `olares install` command installs Olares on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles.
The `olares install` command installs beOS Pro on your system. It supports various options to customize the installation process, such as specifying directories, Kubernetes types, or Minikube profiles.
```bash
olares-cli olares install [option]
@@ -11,9 +11,9 @@ olares-cli olares install [option]
| Name | Shorthand | Usage |
|--------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--help` | `-h` | Displays help information. |
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |

8
docs/developer/develop/advanced/cli/olares-prepare.md
View File

@@ -1,7 +1,7 @@
# `olares prepare`
## Synopsis
The `olares prepare` command sets up the environment required for Olares to function. This includes installing dependencies, importing container images, and starting the Olares daemon (`olaresd`).
The `olares prepare` command sets up the environment required for beOS Pro to function. This includes installing dependencies, importing container images, and starting the beOS Pro daemon (`olaresd`).
```bash
olares-cli olares prepare [option]
```
@@ -10,13 +10,13 @@ olares-cli olares prepare [option]
| Name | Shorthand | Usage |
|----------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--help` | `-h` | Displays help information. |
| `--kube` | | Specifies the Kubernetes type. <br>Supported types are `k3s` (default) and `k8s`. |
| `--profile` | `-p` | Sets the Minikube profile name. Only applicable on macOS. <br> Defaults to `olares-0`. |
| `--registry-mirrors` | `-r` | Specifies Docker container registry mirrors. <br> Multiple mirrors should be separated by commas. |
| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for Olares workloads instead of the local disk. |
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
| `--with-juicefs` | | Configures JuiceFS as the root filesystem (rootfs) for beOS Pro workloads instead of the local disk. |
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |
## Example
```bash

6
docs/developer/develop/advanced/cli/olares-release.md
View File

@@ -1,7 +1,7 @@
# `olares release`
## Synopsis
Build a release version based on a local Olares repository. This command should be run in the root directory of the Olares repository.
Build a release version based on a local beOS Pro repository. This command should be run in the root directory of the beOS Pro repository.
```bash
olares-cli olares release [option]
@@ -11,10 +11,10 @@ olares-cli olares release [option]
| Name | Shorthand | Usage |
|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--download-cdn-url` | | Sets the CDN URL used for downloading checksums of dependencies and images. <br> Defaults to `https://dc3p1870nn3cj.cloudfront.net`. |
| `--extract` | `-e` | Extracts the release to the `--base-dir` after the build. Set to `false` if only the release file itself is needed. <br> Defaults to `true`. |
| `--help` | `-h` | Displays help information. |
| `---ignore-missing-images` | | Ignores missing images when downloading checksums from the CDN. <br> Disable this only if no new images are added, as the build may fail if the image is not uploaded to the CDN yet. <br> Defaults to `true`. |
| `--version` | `-v` | Specifies the Olares version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/Olares/releases) for available versions. |
| `--version` | `-v` | Specifies the beOS Pro version. <br>Version values follow the format `x.y.z` (e.g., `1.10.0`) or include a build date (e.g., `1.10.0-20241109`).<br> Refer to the [GitHub Releases page](https://github.com/beclab/beOS Pro/releases) for available versions. |

10
docs/developer/develop/advanced/cli/olares-uninstall.md
View File

@@ -1,7 +1,7 @@
# `olares uninstall`
## Synopsis
Uninstall Olares from your machine.
Uninstall beOS Pro from your machine.
```bash
olares-cli olares uninstall [option]
@@ -11,9 +11,9 @@ olares-cli olares uninstall [option]
| Name | Shorthand | Usage |
|--------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--all` | | Uninstalls Olares completely, including dependencies installed during the "prepare" phase. |
| `--base-dir` | `-b` | Sets the base directory for Olares.<br> Defaults to `$HOME/.olares`. |
| `--all` | | Uninstalls beOS Pro completely, including dependencies installed during the "prepare" phase. |
| `--base-dir` | `-b` | Sets the base directory for beOS Pro.<br> Defaults to `$HOME/.olares`. |
| `--help` | `-h` | Displays help information. |
| `--phase` | | Uninstalls Olares from a specific phase and revert to the previous one. <br> For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage. <br>Defaults to `install`. |
| `--phase` | | Uninstalls beOS Pro from a specific phase and revert to the previous one. <br> For example, `--phase install` removes tasks performed during the "install" phase, reverting the system to the "prepare" stage. <br>Defaults to `install`. |
| `--quiet` | | Enables quiet mode (suppress output). <br> Defaults to `false`. |
| `--version` | `-v` | Specifies the Olares version to uninstall. <br>Use `olares-cli olares info` to check the downloaded version first. |
| `--version` | `-v` | Specifies the beOS Pro version to uninstall. <br>Use `olares-cli olares info` to check the downloaded version first. |