Skip to content

chore: update shared app related doc #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/manual/concepts/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Olares supports unified authentication for a multi-user system.
2. Each user request first goes through the Authelia service for authentication.
3. If authentication fails, the application redirects the user to the login page to re-authenticate.
4. If authentication succeeds, the [Backend for Launcher (BFL)](https://github.com/beclab/bfl) attaches the user's basic information and forwards the request to the application service. This relieves the application from handling the authentication itself.
5. For [cluster-scoped applications](./application.md#cluster-scoped-applications), developers need to build an additional `Auth Server` to connect the application's account with the BFL account.
5. For [shared applications](./application.md#shared-applications), developers need to build an additional `Auth Server` to connect the application's account with the BFL account.

## Multi-factor authentication (MFA)

Expand Down
23 changes: 15 additions & 8 deletions docs/manual/concepts/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,19 +80,26 @@ n8n-alice
gitlab-client-bob
```

### Cluster-scoped applications
### Shared applications

Cluster-scoped applications are special community applications designed to share resources or services across the entire Olares cluster. They run continuously as service providers, with the following operating rules:
A **shared application** is a special category of community applications on Olares designed to provide unified, shared resources or services to all users within an Olares cluster.

- Only one instance is permitted per cluster.
- Only administrators can install and manage cluster-scoped applications.
- They are identifiable by their "for Cluster" suffix and a "Cluster-scoped" label in the Olares app market.
- Users need to access a cluster-scoped application through its authorized applications. For example, "ComfyUI for Cluster" provides cluster-wide services that users access through its authorized client application "ComfyUI".
Key characteristics of shared applications include:

### Authorized applications
Authorized applications serve as client-side interfaces for cluster-scoped applications. Both administrators and regular members can install these applications.
* **Centralized management**: Only administrators can install the core service of a shared application. Administrators are responsible for installing, configuring, and hosting the app's service, resources, and runtime environment within the cluster.
* **Easy identification**: In Olares Market, shared applications are typically marked with a "Shared" label for easy identification.
* **Flexible access**: The method for accessing a shared application depends on the app's form:
* **Headless backend service**: For shared applications that typically run as a background service without a graphical UI (e.g., Ollama), users need to install a **reference application** to call the service. For example, users within the cluster can access the Ollama service via Open WebUI or LobeChat.
* **Complete application with built-in UI**: For shared applications that include a complete user interface and backend service themselves (e.g., ComfyUI Shared or Dify Shared), administrators and other users in the cluster can obtain the service access point by directly installing the shared application itself.

### Reference applications

Reference applications are applications that have been granted access to specific shared applications within Olares. They typically provide a user-friendly interface, allowing users to easily access the APIs or services exposed by the shared applications.

For example, Open WebUI, LobeChat, and n8n are reference applications for Ollama. Dify Shared is the reference application of itself.

### Dependencies

Dependencies are prerequisite applications that must be present for certain applications to function properly. Before installing an application with dependencies, users must ensure all required dependencies are already installed in the cluster.

### Service provider
Expand Down
4 changes: 2 additions & 2 deletions docs/manual/tasks/gpu-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ For users requiring dedicated GPU resources, standalone mode can be enabled:
* Large memory requests may limit resources available for subsequent applications.

:::info
For cluster-scoped applications, such as SD Web UI (Stable Diffusion) and ComfyUI, GPU memory is managed by the cluster-scoped application itself, not individual user instances.
This means that the GPU mode settings described here do not directly affect authorized applications.
For shared applications, such as SD Web UI (Stable Diffusion) and ComfyUI, GPU memory is managed by the shared application itself, not individual user instances.
This means that the GPU mode settings described here do not directly affect reference applications.
:::

## Change GPU mode for application
Expand Down
32 changes: 20 additions & 12 deletions docs/manual/tasks/install-uninstall-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Before you start, it is recommended to familiarize yourself with a few concepts
|------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
| [System application](../concepts/application.md#system-applications) | Built-in applications that come pre-installed with Olares, such as Profile, Files, and Vault. |
| [Community application](../concepts/application.md#community-applications) | Applications that are created and maintained by third-party developers. |
|   [Cluster-scoped application](../concepts/application.md#cluster-scoped-applications) | A special type of community application that can only be installed by Olares admin and only one instance is allowed per cluster. |
|     [Authorized application](../concepts/application.md#authorized-applications) | The client-side interfaces for cluster-scoped applications. |
|   [Shared application](../concepts/application.md#cluster-scoped-applications) | A special category of community applications on Olares designed to provide unified, shared resources or services to all users within an Olares cluster. Only one instance is allowed per cluster. |
|     [Reference application](../concepts/application.md#reference-applications) | The applications that have been granted access to specific shared applications |
| [Dependencies](../concepts/application.md#dependencies) | Prerequisite applications that must already be installed before a user can access an application that requires them. |

## Find applications
Expand Down Expand Up @@ -49,16 +49,26 @@ You can also browse applications based on their functionality:
To cancel an installation, hover over the operation button and click **Cancel** when it appears.
:::

### Install cluster-scoped and authorized applications
In this context, a cluster refers to a server cluster within the Olares system that provides shared resources and services to multiple users. Cluster-scoped applications serve the entire cluster, while authorized applications allow individual users to access these services.
### Install shared and reference applications

Therefore, to make sure a cluster-scoped service is running normally, follow the general process:
To ensure a shared service is running and accessible within the cluster, follow this general installation process based on the type of Shared App:

1. Install the cluster-scoped application first (for Olares admin).
Once installation is complete, the operation button will display "**Running**".
2. Install the corresponding authorized application (for all Olares user).
* **Headless backend service**:
This type of shared applications typically require third-party reference applications to access its service. Take Ollama for example:
1. The administrator installs the shared application first. This makes the core service available in the cluster.

2. Members (including the administrator) install the corresponding reference application (e.g., Open WebUI or LobeChat) to access the Ollama service.

After installation, users can access the cluster-scoped application's services by running the authorized application.
* **Complete application with built-in UI**:
This type of shared applications can provide service to itself. Typical examples are Dify Shared and ComfyUI Shared.

1. The administrator installs the shared application first. This not only launches the shared service for the cluster, but also installs the client-side interface as the reference application.

::: tip ComfyUI Launcher
ComfyUI Shared contains a web launcher component to facilitate the management of related services and resources. The administrator needs to configure and start the service from the ComfyUI Launcher.
:::

2. Other members in the cluster install the same application. For these users, only the access point to the shared application is installed.

### Install custom applications

Expand Down Expand Up @@ -94,6 +104,4 @@ If you can't install an application, it might be due to:
* **Insufficient system resources**: Try freeing up system resources, or increasing your resource quota.
* **Missing dependencies**: Check the **Dependency** section on the application details page and make sure all required apps are installed.
* **Incompatible system version**: Try upgrading Olares to the latest version.
* **Cluster-scoped application restrictions** (for Olares member): Install the authorized app, and contact your Olares admin to install the corresponding cluster-scoped application.


* **Shared application restrictions** (for Olares member): Install the reference app, and contact your Olares admin to install the corresponding shared application.
2 changes: 1 addition & 1 deletion docs/manual/tasks/roles-permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Olares has two default user roles:
<ul>
<li>Create and manage user accounts</li>
<li>Manage vault teams, create shared vaults, and assign read/write permissions for shared vaults</li>
<li>Install and manage cluster-scoped applications</li>
<li>Install and manage shared applications</li>
<li>Monitor and manage system resources</li>
<li>Set GPU usage mode</li>
<li>Update Olares</li>
Expand Down
3 changes: 2 additions & 1 deletion docs/manual/use-cases/dify.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ To use local AI models on Dify, ensure you have:
Starting from Olares 1.11.6, if "Dify For Cluster" or "Dify" was previously installed, uninstall them before proceeding.
:::

Install "Dify Shared" from Olares Market.
1. Install "Dify Shared" from Olares Market.
2. Launch Dify from your desktop. Please ensure the admin has already installed Dify Shared.

## Create an AI assistant app

Expand Down
17 changes: 9 additions & 8 deletions docs/manual/use-cases/openwebui.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,20 +77,21 @@ Recommended starter models for optimal performance (13B parameters or smaller):
- Configure **Temperature** settings

### Text-to-speech
1. Install OpenedAI Speech from Market.
1. The admin installs OpenedAI Speech from Market. This launches the service within the cluster.
:::info
"OpenedAI Speech" is a cluster-scoped application and can only be installed by Olares admin. If you are a team member, ensure that the Olares admin has already installed "OpenedAI Speech".
"OpenedAI Speech" is a shared application and can only be installed by Olares admin. If you are a team member, ensure that the Olares admin has already installed "OpenedAI Speech".
2. Open WebUI, and navigate to **Admin Panel** > **Settings** > **Audio**.
3. Select OpenAI as the text-to-speech engine, with the following configurations:
- API Base URL: `http://openedaispeech.openedaispeech-{admin's local name}:8000/v1`. For example: `http://openedaispeech.openedaispeech-alice123:8000/v1`.
- API key: enter any character.
4. Click **Save**.

### Text-to-image
With [SD Web UI For Cluster installed in your Olares environment](stable-diffusion.md#install-sd-web-ui), you can leverage Stable Diffusion's powerful image generation capabilities directly through Open WebUI.
With [SD Web UI Shared installed in your Olares environment](stable-diffusion.md#install-sd-web-ui), you can leverage Stable Diffusion's powerful image generation capabilities directly through Open WebUI.

1. Open Open WebUI, and navigate to **Admin Panel** > **Settings** > **Images**.
2. Select **Automatic1111** as the image generation engine, with the base URL: `http://sdwebui.sdwebui--{admin's local name}:7860`. For example: `http://sdwebui.sdwebui-alice123:7860`.
3. Click <i class="material-symbols-outlined">cached</i> to verify the connection.
4. Turn on **Image Generation (Experimental)**, and select your preferred text-to-image model checkpoint.
5. Click **Save**.
1. The admin installs SD Web UI Shared from Market. This launches the Stable Diffusion service within the cluster.
2. Open Open WebUI, and navigate to **Admin Panel** > **Settings** > **Images**.
3. Select **Automatic1111** as the image generation engine, with the base URL: `http://sdwebui.sdwebui--{admin's local name}:7860`. For example: `http://sdwebui.sdwebui-alice123:7860`.
4. Click <i class="material-symbols-outlined">cached</i> to verify the connection.
5. Turn on **Image Generation (Experimental)**, and select your preferred text-to-image model checkpoint.
6. Click **Save**.
11 changes: 6 additions & 5 deletions docs/manual/use-cases/perplexica.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Before getting started, ensure you have:
For optimal performance, consider using lightweight yet powerful models like `gemma2`, which offer a good balance between speed and capability.
:::
## Set up Perplexica
1. Install SearXNG from Market based on your role:
- **For admin**: Install both "SearXNG For Cluster" and "SearXNG".
- **For team members**: Ensure your admin has installed "SearXNG For Cluster", and install "SearXNG" only.

![Install SearXNG](/images/manual/use-cases/install-searxng.png){width=40%}

1. The admin installs SearXNG from Market.

:::info
Starting from Olares 1.11.6, if "SearXNG For Cluster" or the "SearXNG" client was previously installed, uninstall them before proceeding.
:::

2. Install Perplexica from Market.
3. Launch Perplexica, and click <i class="material-symbols-outlined">settings</i> in the bottom left corner to open the settings window.
4. Configure your search environment with the following settings (using `gemma2` as an example):
Expand Down
13 changes: 8 additions & 5 deletions docs/manual/use-cases/stable-diffusion.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,16 @@ Whether you're an artist looking to expand your creative toolkit, a developer in

## Install SD Web UI

The installation process is straightforward, with just a couple of steps based on your role:
* **For admin**: Install both "SD Web UI For Cluster" and "SD Web UI".
* **For team members**: Ensure your admin has installed "SD Web UI For Cluster", and install "SD Web UI" only.
:::info
Starting from Olares 1.11.6, if "SD Web UI For Cluster" or "SD Web UI" was previously installed, uninstall them before proceeding.
:::

1. Install SD Web UI Shared directly from Market.

2. Launch SD Web UI from your desktop. Please ensure the admin has already installed SD Web UI Shared.

![Install SD Web UI](/images/manual/use-cases/install-sd.png){width=40%}
Now you are ready to unleash your creativity and start generating stunning images!

Launch SD Web UI from your desktop, and voilà - unleash your creativity and start generating stunning images!
## Prevent conflicts among members
In SD Web UI, checkpoint settings are globally applied to all users by default. When one user switches to a different checkpoint, all subsequent image generations by other users will also use this newly selected checkpoint. To prevent workflow disruptions in multi-user environments, you could specify checkpoints for individual tasks.

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/manual/concepts/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Olares 支持多用户系统的统一认证。
2. 每个用户请求都会先经过 Authelia 服务进行认证。
3. 如果认证失败,应用会将用户重定向到登录页面重新认证。
4. 如果认证成功,[Backend for Launcher (BFL)](https://github.com/beclab/bfl) 会附加用户的基本信息并将请求转发给应用服务。这样应用本身就不需要处理认证逻辑。
5. 对于[集群应用(Cluster-scoped application)](./application.md#集群应用),开发者需要构建额外的 `Auth Server` 来连接应用账号与 BFL 账号。
5. 对于[共享应用(Shared application)](./application.md#共享应用),开发者需要构建额外的 `Auth Server` 来连接应用账号与 BFL 账号。

## 多因素认证(MFA)

Expand Down
20 changes: 13 additions & 7 deletions docs/zh/manual/concepts/application.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,17 +80,23 @@ n8n-alice
gitlab-client-bob
```

### 集群应用
### 共享应用

集群应用是一类特殊的社区应用,旨在为整个 Olares 集群共享资源或服务。它们作为服务提供者持续运行,遵循以下规则:
**共享应用**是 Olares 平台中的一类特殊社区应用,旨在为 Olares 集群内的所有用户提供统一的、共享的资源或服务。

- 每个集群仅允许安装一个实例
- 仅管理员可以安装和管理集群应用
- 在 Olares 应用市场中以“for Cluster”后缀和“Cluster-scoped”标签标识
- 用户需要通过其授权应用访问集群应用。例如,“ComfyUI for Cluster”提供集群范围的服务,用户通过其授权客户端应用“ComfyUI”访问
共享应用的特点包括:

* **集中管理**:只有管理员账户才安装共享版应用的核心服务。管理员负责在 Olares 集群内**安装、配置和托管**应用的服务、资源以及运行环境。
* **易于识别**:在 Olares 应用市场中,共享版应用通常带有 "Shared" 标识以便用户区分。
* **灵活访问**:访问共享版应用的方式取决于共享应用本身的形态:
* **无界面的后端服务**: 对于通常在后端提供服务没有直接用户界面的共享应用(如 Ollama),用户通常需要通过安装一个**授权应用**作为访问入口。例如,可以通过 Open WebUI 或 LobeChat 访问 Ollama 服务。
* **自带用户界面的完整应用**: 对于共享版应用本身就包含完整用户界面和后端服务的(例如,ComfyUI 共享版 或 Dify 共享版),管理员和集群中的其他用户都可通过直接安装该共享版应用本身获取服务的访问入口。

### 授权应用
授权应用是集群应用的客户端界面。管理员和普通成员都可以安装。

授权应用是指具有 Olares 中特定共享应用访问权限的应用。它们通常为用户提供可交互界面,以便访问被授权共享应用的 API 或服务。

例如,Open WebUI、LobeChat 和 n8n 是 Ollama 的授权应用。Dify Shared 是它自身的授权应用。

### 依赖项
依赖项是某些应用正常运行所必需的前置应用。安装带有依赖项的应用前,用户必须确保集群中已安装所有必需的依赖项。
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/manual/tasks/gpu-resource.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Olares 提供灵活的 GPU 显存管理功能,以支持图像生成和大语
* 大内存请求可能会限制后续应用的可用资源

:::info
对于集群应用,如 SD Web UI(Stable Diffusion)和 ComfyUI,GPU 显存由集群应用自行管理,而不是由单个用户实例管理。
对于共享应用,如 SD Web UI(Stable Diffusion)和 ComfyUI,GPU 显存由共享应用自行管理,而不是由单个用户实例管理。
这意味着这里描述的 GPU 模式设置不会直接影响这些授权应用。
:::

Expand Down
Loading