diff --git a/docs/manual/concepts/account.md b/docs/manual/concepts/account.md index dc14ac1e..db5bd32e 100644 --- a/docs/manual/concepts/account.md +++ b/docs/manual/concepts/account.md @@ -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) diff --git a/docs/manual/concepts/application.md b/docs/manual/concepts/application.md index 6295d5de..b734eb35 100644 --- a/docs/manual/concepts/application.md +++ b/docs/manual/concepts/application.md @@ -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 diff --git a/docs/manual/tasks/gpu-resource.md b/docs/manual/tasks/gpu-resource.md index d85cbf1c..ed721a0a 100644 --- a/docs/manual/tasks/gpu-resource.md +++ b/docs/manual/tasks/gpu-resource.md @@ -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 diff --git a/docs/manual/tasks/install-uninstall-update.md b/docs/manual/tasks/install-uninstall-update.md index 67fea885..e8f31afa 100644 --- a/docs/manual/tasks/install-uninstall-update.md +++ b/docs/manual/tasks/install-uninstall-update.md @@ -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 @@ -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 @@ -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. diff --git a/docs/manual/tasks/roles-permissions.md b/docs/manual/tasks/roles-permissions.md index 5141f175..6d173d15 100644 --- a/docs/manual/tasks/roles-permissions.md +++ b/docs/manual/tasks/roles-permissions.md @@ -36,7 +36,7 @@ Olares has two default user roles: