Skip to content
Open
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
4 changes: 4 additions & 0 deletions docs/.vitepress/en.ts
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,10 @@ const side = {
text: "Basic file operations",
link: "/manual/olares/files/add-edit-download",
},
{
text: "Use Common directory",
link: "/manual/olares/files/files-common",
},
// {
// text: "Sync and share",
// link: "/manual/larepass/sync-share",
Expand Down
4 changes: 4 additions & 0 deletions docs/.vitepress/zh.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,10 @@ const side = {
text: "基本文件操作",
link: "/zh/manual/olares/files/add-edit-download",
},
{
text: "使用公共目录",
link: "/zh/manual/olares/files/files-common",
},
//{
// text: "同步与共享",
// link: "/zh/manual/larepass/sync-share",
Expand Down
69 changes: 69 additions & 0 deletions docs/manual/olares/files/files-common.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
---
outline: [2, 3]
description: Use the Common directory in Olares to manage AI models shared across applications and users.
---

# Manage shared AI models with the Common directory

The Common directory provides a system-level shared space to store AI models. Multiple applications and users access the exact same model files simultaneously to save storage space and eliminate duplicate downloads.

## Understand the Common directory

### How the Common directory works

Understand Olares's file storage mechanisms to see the benefits of the Common directory.

The following table shows the storage strategies for different locations in the Files app:

| Node | File management strategy | Cross-user sharing | Cross-app sharing |
| :------| :------------| :---------| :------- |
| **Storage** | Isolated by user | ❌ | ✅ |
| **Data** | Isolated by application | ✅ | ❌ |
| **Common** | Shared across users and applications | ✅ | ✅ |

**Storage** and **Data** isolate files, which creates challenges in AI scenarios:
- **Difficulty sharing models between applications**: Multiple AI applications might require the same underlying models. For example, ComfyUI and Stable Diffusion share the same image model files, and vLLM and llama.cpp can read from the same Hugging Face cache directory. Isolated storage prevents direct reuse of these files across applications.
- **Wasted space from repeated downloads**: Storing massive model files in isolated user or application directories forces different applications or users to download the same model repeatedly. This wastes disk space and network bandwidth.

The Common directory resolves these issues. It provides a centralized space where different apps and users read the same model files, eliminating storage redundancy.

![Common directory interface](/images/manual/olares/files-common.png#bordered)

### Default directory structure

The Common directory includes three default subdirectories. Each follows the official storage structure of its corresponding platform:

| Subdirectory | Function | Directory structure |
|:------|:----|:-----------|
| **huggingface** | Stores cached models downloaded<br> via the Hugging Face CLI. Applications<br> such as vLLM, transformers, and llama.cpp <br>read from this unified cache. | Mirrors the official cache structure exactly.<br><br>For details on file organization, see the [Hugging Face cache management guide](https://huggingface.co/docs/huggingface_hub/guides/manage-cache). |
| **comfyui** | Stores models shared between ComfyUI <br>and related applications, such as<br> Checkpoint, LoRA, and VAE. | Follows the standard ComfyUI `models` folder structure.<br><br>For details on file organization, see the [ComfyUI models documentation](https://docs.comfy.org/development/core-concepts/models).|
| **ollama** | Stores models pulled and managed by Ollama. | Uses Ollama's unique manifests and blobs storage mechanism.<br><br>For more information, see the [Ollama FAQ](https://docs.ollama.com/faq#where-are-models-stored). |

## Upgrade to use the Common directory

Olares V1.12.6 includes the Common directory by default.

If you are using an older version of Olares, do not manually migrate existing model files. Manual migration involves complex steps and risks breaking application dependencies. Instead, follow these steps to upgrade:

1. Upgrade Olares to V1.12.6.
2. Uninstall your existing AI applications.
3. Install the V3 versions of these applications from the Market.
4. Re-download your required models. The V3 applications automatically store models in the new Common directory.

## Find and manage shared models

Access the Common directory in the Files app and manage shared models centrally.

### Access the Common directory

1. Open the Files app from the Launchpad.
2. Select **Application** > **Common** in the left sidebar.
3. Open the `huggingface`, `ollama`, or `comfyui` subdirectory.
4. Find your target model file.

### Manage files

You can add or delete model files in the Common directory, but you must maintain the official recommended structure for each subdirectory. Applications might fail to load models if you change the required hierarchy.

- **Add models**: Drag and drop model files directly into the corresponding subdirectory.
- **Delete models**: Right-click the model folder and select **Delete** to free up space. After deletion, related applications immediately lose access to the model and require a re-download to use it again.
11 changes: 8 additions & 3 deletions docs/manual/olares/files/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Olares's built-in Files app offers users a secure and efficient solution for fil

The interface is similar to Windows Explorer or macOS Finder, allowing you to organize and access documents, images, videos, or any other files you own.

![Files](/images/manual/olares/files-index.png#bordered)
![Files](/images/manual/olares/files-index2.png#bordered)

It mainly consists of the following components:

* **Drive**: Stores personal files that don’t require constant synchronization or frequent edits. Each user has a Home directory with default folders such as Documents, Pictures, Videos, and Downloads. External storage (e.g., USB drives or SMB shares) appears under External.
* **Sync**: A library-based high-efficiency storage area providing file synchronization services. You can create multiple independent libraries, each serving as a separate file entry point (similar to an independent cloud drive). Ideal for storing files and data requiring frequent modifications, real-time cross-device synchronization, or team collaboration.
* **Application**: Reserved for application-specific data. Primarily for development and debugging, not general file storage.
* **Cloud storage**: Connected through [Integrations](../../larepass/integrations.md), including Google Drive, AWS S3, and Tencent Cloud Object Storage (COS). These allow you to link, access, and manage remote files directly from Olares.
* **Application**: Stores application-related data and system-level shared assets. It includes isolated data directories for individual applications (primarily for development and debugging) and a Common directory that stores shared AI models accessible across multiple applications and users.
* **Cloud drive**: Connected through [Integrations](../../larepass/integrations.md), including Google Drive, AWS S3, and Tencent Cloud Object Storage (COS). These allow you to link, access, and manage remote files directly from Olares.
* **Share**: The centralized hub for managing all shared folders, including Internal shares, SMB shares, and Public shares, allowing you to monitor sharing status, adjust permissions, or cancel shares in one place.

---
Expand All @@ -29,6 +29,11 @@ It mainly consists of the following components:
Learn the fundamentals of file management in Olares.
</div>

<div>
<h4><a href="./common">Use Common directory</a></h4>
Learn how applications share AI models and cache data in the Common directory.
</div>

<div>
<h4><a href="./mount-SMB">Mount SMB</a></h4>
Learn how to mount and access SMB shared folders from NAS devices or network servers in Olares.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/public/images/manual/olares/files-index.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions docs/zh/manual/olares/files/files-common.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
outline: [2, 3]
description: 了解如何在 Olares 中使用 Common 目录管理跨应用、跨用户共享的 AI 模型。
---

# 使用公共目录管理共享 AI 模型

公共目录是一个系统级共享空间,用于存储 AI 模型,使多个应用和多个用户能够同时访问相同的模型文件。

## 了解公共目录

### 公共目录的工作原理

要理解公共目录的作用,需要先了解 Olares 的文件存储机制。下表展示了文件管理器中不同位置的存储策略:

| 节点位置 | 文件管理策略 | 跨用户共享 | 跨应用共享 |
| :------| :------------| :---------| :------- |
| **存储** | 按用户隔离 | ❌ | ✅ |
| **数据** | 按应用隔离 | ✅ | ❌ |
| **公共** | 跨用户、跨应用共享 | ✅ | ✅ |

**存储**和**数据**都在一定程度上隔离了文件,但这在 AI 场景下会带来两个问题:
- **应用间难以共享模型**:多个 AI 应用可能需要同一套底层模型,例如 ComfyUI 和 Stable Diffusion 共用的图像模型文件,或 vLLM 和 llama.cpp 共用的 Hugging Face 缓存目录。但在隔离的存储机制下,这些文件无法跨应用直接复用。
- **重复下载造成的空间浪费**:若将模型文件分别存放在隔离的存储目录或应用目录中,不同应用或用户会重复下载同一模型,浪费时间和空间。

公共目录通过提供跨用户、跨应用的共享存储解决了上述问题,让不同应用和用户访问相同的模型文件,避免重复存储。

![公共目录界面](/images/zh/manual/olares/files-common.png#bordered)

### 公共目录的结构

公共目录默认包含以下三个子目录,分别遵循对应平台的官方存储结构:

| 子目录 | 用途 | 目录结构说明 |
|:------|:----|:-----------|
| **huggingface** | 存储通过 Hugging Face CLI 下载的缓存模型。<br>vLLM、transformers 和 llama.cpp 等应用都从<br>这个统一缓存中读取数据。 | 完全镜像官方的缓存结构。<br><br>详细了解文件组织方式,请参考 [Hugging Face 官方缓存管理指南](https://huggingface.co/docs/huggingface_hub/guides/manage-cache)。 |
| **comfyui** | 存储在 ComfyUI 及相关应用之间共享的模型<br>(如 Checkpoint、LoRA 和 VAE)。 | 遵循标准的 ComfyUI `models` 文件夹结构。<br><br>详细了解文件组织方式,请参考 [ComfyUI 官方模型文档](https://docs.comfy.org/development/core-concepts/models)。 |
| **ollama** | 存储由 Ollama 拉取和管理的模型。 | 采用 Ollama 独特的 manifests 和 blobs 存储机制。<br><br>更多信息,请参考 [Ollama 官方 FAQ](https://docs.ollama.com/faq#where-are-models-stored)。 |

## 升级以使用公共目录

Olares V1.12.6 默认提供 Common 目录,无需单独安装。

如果你使用的是旧版本 Olares,请勿手动迁移旧的模型文件。手动迁移步骤复杂,且容易破坏应用依赖。建议按以下步骤操作:

1. 将 Olares 升级至 V1.12.6。
2. 卸载现有的 AI 应用。
3. 从应用商店重新安装这些应用的 V3 版本。
4. 重新下载所需模型。V3 版本的应用会自动将模型存储在公共目录。

## 查找和管理共享模型

在文件管理器中访问共享目录,并集中管理。

### 访问目录

1. 从启动台打开文件管理器。
2. 选择左侧边栏中的 **应用** > **公共**。
3. 进入 `huggingface`、`ollama` 或 `comfyui` 子目录。
4. 找到目标模型文件。

### 管理文件

你可以在公共目录中添加或删除模型文件,但必须保持各子目录的官方推荐结构,否则应用可能无法正确加载模型。

- **添加模型**:直接将模型文件拖放到对应的子目录中。
- **删除模型**:右键点击模型文件夹,选择删除以释放空间。删除后,相关应用将立即失去对该模型的访问权限,需要重新下载才能再次使用。
9 changes: 7 additions & 2 deletions docs/zh/manual/olares/files/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Olares 内置的文件应用为用户提供了安全高效的文件存储与同

文件管理器的界面类似于 Windows 资源管理器或 macOS 的访达,允许你整理和访问文档、图片、视频或其他文件。主要由以下几个部分组成:

![Files](/images/zh/manual/olares/files-index-1.png#bordered)
![Files](/images/zh/manual/olares/files-index-3.png#bordered)

* **存储**:用于存储个人文件,适合那些不需要频繁同步或修改的内容。每个用户都有一个首页目录,默认包含文档、图片、影视、下载等文件夹。外部存储(如 USB 驱动器或 SMB 共享)会显示在**外部设备**下。
* **同步**:基于资料库(Library)的高效存储区,提供文件同步服务。你可以创建多个独立的资料库,每个库均作为一个单独的文件入口(类似于独立的网盘空间)。适合存放需要频繁修改、跨设备实时同步或团队协作的文件和数据。
* **应用**:存储应用与缓存数据,主要用于开发和调试目的
* **应用**:存储与应用相关的数据以及系统级共享资源。其中包括为各个应用隔离的数据目录(主要用于开发和调试),以及一个公共目录,用于存储可被多个应用和用户共享访问的 AI 模型
* **云存储**:通过[集成](../../larepass/integrations.md)功能连接的外部云存储服务,包括 Google Drive、AWS S3 和 腾讯云 COS。可直接在 Olares 中挂载、访问和管理远程文件。
* **分享**:用于集中管理所有已开启共享的项目,包括内部分享、SMB 分享和公开分享,方便统一查看分享状态、调整用户权限或取消共享。

Expand All @@ -27,6 +27,11 @@ Olares 内置的文件应用为用户提供了安全高效的文件存储与同
了解 Olares 中文件管理的基本操作。
</div>

<div>
<h4><a href="./common">使用公共目录</a></h4>
了解应用如何在 Common 目录中共享 AI 模型和缓存数据。
</div>

<div>
<h4><a href="./mount-SMB">挂载 SMB</a></h4>
了解如何在 Olares 中挂载并访问 NAS 设备或网络服务器上的 SMB 共享文件夹。
Expand Down