diff --git a/docs/developer/develop/package/manifest.md b/docs/developer/develop/package/manifest.md index 77d56688..6fe0e5eb 100644 --- a/docs/developer/develop/package/manifest.md +++ b/docs/developer/develop/package/manifest.md @@ -311,10 +311,10 @@ ports: ``` ::: -Olares automatically assigns a random port (33333-36789) for your app. These ports can be accessed via the app entrance domain from local network. For example: `84864c1f.local.your_olares_id.olares.com:33805`. +Olares automatically assigns a random port (33333-36789) for your app. These ports can be accessed via the app entrance domain. For example: `84864c1f.your_olares_id.olares.com:33805`. :::info NOTE -The exposed ports can only be accessed on the local network or through a VPN. +The exposed ports can only be accessed through LarePass VPN. ::: ## Permission diff --git a/docs/manual/concepts/network.md b/docs/manual/concepts/network.md index 8e764c89..b5e04b4c 100644 --- a/docs/manual/concepts/network.md +++ b/docs/manual/concepts/network.md @@ -23,11 +23,15 @@ Each Olares application can have one or more entrances that serve as access poin - **Internal entrance** - Functions similarly to private entrance - - No authentication required when accessing applications through local network or VPN + - No authentication required when accessing applications through LarePass VPN -## Local access +## Acccess to private entrances via VPN -When accessing applications on Olares within a LAN or after starting a [private network](/manual/larepass/private-network.md), you can add the `.local` field to the application URL for faster access speeds. For example, `https://vault.local.alice123.olares.com`. +Simply enable [LarePass VPN](/manual/larepass/private-network.md) on your device to securely and quickly access your private applications via their dedicated URLs (e.g., https://vault.alice123.olares.com). + +::: tip Note +If LarePass VPN is not enabled, requests to your private entrances will be routed through your reverse proxy tunnel to Olares, which may cause network latency and incur charges. +::: ## Endpoints diff --git a/docs/manual/larepass/private-network.md b/docs/manual/larepass/private-network.md index bb714a4f..d447d92b 100644 --- a/docs/manual/larepass/private-network.md +++ b/docs/manual/larepass/private-network.md @@ -1,14 +1,31 @@ --- outline: [2, 3] -description: Access Olares applications securely from anywhere using LarePass VPN. Learn VPN setup, troubleshooting, and how to enforce VPN-only access for maximum security. +description: Access Olares applications securely from anywhere using LarePass VPN. Learn about VPN setup and troubleshooting in LarePass. --- # Access Olares anywhere via LarePass VPN -By enabling Virtual Private Network (VPN) in LarePass, all traffic from the device to Olares is routed through a secure private network, providing the same experience as local access. +Enabling the LarePass VPN creates a secure, private connection to your Olares. It's the simplest and most reliable way to access your private applications and services from anywhere, guaranteeing both security and speed. -This document walks you through how to set up LarePass VPN to access Olares anywhere. +This document walks you through how to enable LarePass VPN. +## How access works in Olares + +In Olares, you access applications & services via their dedicated URLs (e.g., `app.local.yourname.olares.com`). Depending on the intended accessibility, there are two types of entrances: + +- **Public entrance**: Accessible to anyone with no authentication. For example, a blog page that you host on WordPress. Traffic is routed through Cloudflare Tunnel or FRP before reaching Olares. +- **Private entrance**: Intended only for you, such as Desktop, Vault, the management console of WordPress. There are two scenarios when accessing private entrances: + + - LarePass VPN enabled: Traffic is routed through VPN (TailScale) wherever you are. + - LarePass VPN not enabled: Traffic routing is the same way as public entrances. + +::: warning Always enable VPN for private access +For the best experience with private entrances, we strongly recommend enabling the LarePass VPN. It ensures your connection is always encrypted, direct, and fast. +::: + +::: tip Note +Starting with Olares 1.12, you no longer need a separate `.local` address (e.g., `app.local.yourname.olares.cn`) for local access to private applications. The single address (e.g., `app.yourname.olares.cn`) now automatically provides a fast, direct connection when the LarePass VPN is active. +::: ## Enable VPN on LarePass diff --git a/docs/manual/olares/settings/custom-app-domain.md b/docs/manual/olares/settings/custom-app-domain.md index 854a29e3..0bc67e3f 100644 --- a/docs/manual/olares/settings/custom-app-domain.md +++ b/docs/manual/olares/settings/custom-app-domain.md @@ -23,11 +23,7 @@ Olares provides two methods to optimize application access addresses: ### Custom route ID Route ID is a crucial component in accessing your Olares applications. It forms part of the URL you use to reach your applications through a web browser: -`https://{routeID}.local.{OlaresDomainName}` - -::: info - `local` in a URL signifies a private access point, typically used by apps offering services for individual users, families, or teams. Public-facing apps hosting external services do not include `local` in their URLs. For more details, see [entrance](../../concepts/network.md#entrance). -::: +`https://{routeID}.{OlaresDomainName}` For convenience, Olares uses easy-to-remember route IDs for pre-installed system applications. For community applications, you can quickly obtain a simple and memorable URL by changing the route ID. To use Jellyfin as an example: @@ -41,7 +37,7 @@ For community applications, you can quickly obtain a simple and memorable URL by ![Custom route ID](/images/manual/olares/custom-route-id.png#bordered) 6. Click **Confirm**. -Now, you will be able to access Jellyfin from your new URL: `https://jellyfin.local.bob.olares.com`. +Now, you will be able to access Jellyfin from your new URL: `https://jellyfin.bob.olares.com`. ### Custom domain name Instead of using the default Olares domain, you can use your own domain name to access your applications, making them more professional and easier to remember. To use Affine as an example: diff --git a/docs/use-cases/comfyui-for-krita.md b/docs/use-cases/comfyui-for-krita.md index 01a48be8..a166f19a 100644 --- a/docs/use-cases/comfyui-for-krita.md +++ b/docs/use-cases/comfyui-for-krita.md @@ -43,9 +43,7 @@ Before starting, ensure you have: 4. Launch ComfyUI from your desktop, and verify the installation by generating a sample image. 5. Copy the address of ComfyUI for next steps. :::tip -For security, you should always run AI applications within your local network. When properly configured, your ComfyUI URL should contain `.local`. - -If `.local` is missing, check your local network environment and make sure no external network proxy service is enabled. +For security, you should always run AI applications with [LarePass VPN enabled](../manual/larepass/private-network.md). ::: ## Set up Krita @@ -77,6 +75,7 @@ Establish a secure connection between Krita and ComfyUI: If connection fails: - Verify network connectivity between your computer and Olares. - Confirm ComfyUI's authentication level is set to "Internal". + - Confirm LarePass VPN is enabled. - Check for and disable any interfering proxy services. - Ensure ComfyUI is running correctly on your Olares. ::: diff --git a/docs/use-cases/dify.md b/docs/use-cases/dify.md index 21f3c431..0e6b7487 100644 --- a/docs/use-cases/dify.md +++ b/docs/use-cases/dify.md @@ -8,6 +8,7 @@ Dify is an AI application development platform. It's one of the key open-source ## Before you begin To use local AI models on Dify, ensure you have: - [Ollama installed](ollama.md) and running in your Olares environment. +- LassPass installed and [VPN enabled](../manual/larepass/private-network.md#enable-vpn-on-larepass) on your device. - [Open WebUI installed](openwebui.md) with your preferred language models downloaded. :::tip For optimal performance, consider using lightweight yet powerful models like `gemma2` or `qwen`, which offer a good balance between speed and capability. @@ -38,7 +39,7 @@ Starting from Olares 1.11.6, if "Dify For Cluster" or "Dify" was previously inst 2. In Dify, navigate to **Settings** > **Model Provider**. 3. Select Ollama as the model provider, with the following configurations: - **Model Name**: Enter the model name. For example: `gemma2`. - - **Base URL**: Enter Ollama's local address: `https://39975b9a1.local.{username}.olares.com`. Replace `{username}` with the Olares Admin's local name. For example, `https://39975b9a1.local.marvin123.olares.com`. + - **Base URL**: Enter Ollama's local address: `https://39975b9a1.{username}.olares.com`. Replace `{username}` with the Olares Admin's local name. For example, `https://39975b9a1.marvin123.olares.com`. ![Add gemma2](/images/manual/use-cases/dify-add-gemma2.png#bordered){width=70%} diff --git a/docs/use-cases/host-cloud-android.md b/docs/use-cases/host-cloud-android.md index e9601be2..cf0f40f6 100644 --- a/docs/use-cases/host-cloud-android.md +++ b/docs/use-cases/host-cloud-android.md @@ -26,11 +26,7 @@ Make sure the following requirements are met: - redroid is resource-intensive. For best performance, we recommend using a machine with at least an 8-core CPU and 16GB of RAM. ::: -- Your device and Olares are on the same local network. - - :::tip Remote access - If your device is on a different network, use [LarePass](https://olares.com/larepass) to enable a private network connection to Olares. - ::: +- Enable [LarePass VPN](../manual/larepass/private-network.md) on your device. ## Install dependent kernel modules @@ -59,7 +55,7 @@ redroid runs as a headless backend on Olares. To install redroid: c. Append the exported port of redroid (`46878`) to the base domain. - As redroid only allows local access, the domain should also include `.local`. Here is an example of our final URL to access the redroid service: `beb583c3.local.olares01.olares.com:46878`. + Here is an example of our final URL to access the redroid service: `beb583c3.olares01.olares.com:46878`. ## Connect to the redroid service @@ -86,20 +82,20 @@ To access the Android instance on Olares, you'll need to connect to the redroid 3. Use `adb` to connect to the redroid service via the URL obtained earlier: ```powershell - .\adb.exe connect beb583c3.local..olares.cn:46878 + .\adb.exe connect beb583c3..olares.cn:46878 ``` The connection is successful if you see the example output: ```powershell # Example output - already connected to beb583c3.local..olares.cn:46878 + already connected to beb583c3..olares.cn:46878 ``` 4. Render UI and audio using `scrcpy`: ```powershell - .\scrcpy.exe -s beb583c3.local..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder + .\scrcpy.exe -s beb583c3..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder ```` Upon successful execution, the command line outputs the device and rendering info. And the Android screen pops up. @@ -137,20 +133,20 @@ On macOS, `scrcpy` does not include `adb` by default, so you'll need to install 4. Connect to the redroid service URL obtained earlier via `adb`: ```bash - adb connect beb583c3.local..olares.cn:46878 + adb connect beb583c3..olares.cn:46878 ``` The connection is successful if you see the example output. ```bash # Example output - already connected to beb583c3.local..olares.cn:46878 + already connected to beb583c3..olares.cn:46878 ``` 5. Render UI and audio using `scrcpy`: ```bash - scrcpy -s beb583c3.local..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder + scrcpy -s beb583c3..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder ``` Upon success, the command line outputs the device information. The Android screen pops up. @@ -178,7 +174,7 @@ Once connected, you can use `adb` to install third-party APK apps on the Android ```powershell # Example output List of devices attached - beb583c3.local..olares.com:46878 device + beb583c3..olares.com:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 ``` @@ -211,7 +207,7 @@ Once connected, you can use `adb` to install third-party APK apps on the Android ```bash # Example output List of devices attached - beb583c3.local..olares.com:46878 device + beb583c3..olares.com:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 ``` diff --git a/docs/use-cases/ollama.md b/docs/use-cases/ollama.md index 5e491043..594b5ca5 100644 --- a/docs/use-cases/ollama.md +++ b/docs/use-cases/ollama.md @@ -11,6 +11,7 @@ This guide will show you how to set up and use Ollama CLI on Olares. ## Before you begin Before you start, ensure that: - You have Olares admin privileges. +- Install LarePass and [enable LarePass VPN](../manual/larepass/private-network.md#enable-vpn-on-larepass) on your device. ## Install Ollama diff --git a/docs/use-cases/openwebui.md b/docs/use-cases/openwebui.md index 8beac431..1d815d20 100644 --- a/docs/use-cases/openwebui.md +++ b/docs/use-cases/openwebui.md @@ -11,6 +11,10 @@ Open WebUI provides an intuitive interface for managing Large Language Models (L * Voice interactions (speech-to-text and text-to-speech) * Image generation capabilities +:::tip Enable LarePass VPN +Make sure your device has LassPass installed and [VPN enabled](../manual/larepass/private-network.md#enable-vpn-on-larepass) to ensure a fast and stable access. +::: + ## Installation Ollama is required prior to launching Open WebUI: * **For admin**: Install both "Ollama" and "Open WebUI". diff --git a/docs/use-cases/perplexica.md b/docs/use-cases/perplexica.md index 72fb1d6d..4e7238a2 100644 --- a/docs/use-cases/perplexica.md +++ b/docs/use-cases/perplexica.md @@ -16,6 +16,7 @@ This integration enables Perplexica to function as a complete search solution wh ## Before you begin Before getting started, ensure you have: - Ollama installed and running in your Olares environment +- [Enable LarePass VPN](../manual/larepass/private-network.md#enable-vpn-on-larepass) on your device. - Open WebUI installed with your preferred language models downloaded :::tip For optimal performance, consider using lightweight yet powerful models like `gemma2`, which offer a good balance between speed and capability. diff --git a/docs/use-cases/stream-game.md b/docs/use-cases/stream-game.md index 274072e1..f51275dc 100644 --- a/docs/use-cases/stream-game.md +++ b/docs/use-cases/stream-game.md @@ -24,10 +24,7 @@ Before you begin, ensure the following: - Olares is up and running on a machine equipped with an NVIDIA GPU. - Your streaming device has Moonlight installed. Visit the [Moonlight website](https://moonlight-stream.org/) to download and install the appropriate version. -- Your streaming device is connected to the same LAN as your Olares. - :::tip Remote streaming - For remote streaming, install LarePass on your streaming device. You can download the appropriate version from the [LarePass site](https://olares.com/larepass). - ::: +- [Enable LarePass VPN](../manual/larepass/private-network.md#enable-vpn-on-larepass) on your streaming device. - You have a valid Steam account to access your games. ## Install Steam Headless @@ -60,7 +57,7 @@ Steam Headless also integrates Sunshine, the streaming server. To stream games u ### Prepare for paring -1. From your Steam client in the browser, get the URL and append `:47990`, for example, `https://139ebc4f0.local..olares.com:47990`. Open this URL to access the Sunshine console page. +1. From your Steam client in the browser, get the URL and append `:47990`, for example, `https://139ebc4f0..olares.com:47990`. Open this URL to access the Sunshine console page. ![Sunshine console page](/images/manual/tutorials/access-sunshine.png#bordered) @@ -77,10 +74,10 @@ Steam Headless also integrates Sunshine, the streaming server. To stream games u 1. Open the Moonlight client on your streaming device and click the add_to_queue button in the top-right corner. -2. When promoted to enter the IP address of your host PC, enter the local URL of Steam, for example, `139ebc4f0.local..olares.com`. +2. When promoted to enter the IP address of your host PC, enter the URL of Steam, for example, `139ebc4f0..olares.com`. ::: tip Note - Do not include `https://` and make sure to include the `.local` part in the hostname. + Do not include `https://`. ::: 3. Click **OK**, and a host icon appears in locked status. diff --git a/docs/use-cases/stream-media.md b/docs/use-cases/stream-media.md index 49104831..368f631b 100644 --- a/docs/use-cases/stream-media.md +++ b/docs/use-cases/stream-media.md @@ -13,17 +13,13 @@ In this tutorial, you will learn how to: - Install and set up Jellyfin for media streaming. ## Enable Olares VPN connection -To achieve smooth streaming over external networks, enable the Olares VPN connection in LarePass. This ensures all traffic from devices with LarePass installed routes through the dedicated network, providing LAN-like speed and performance. +To achieve smooth streaming across networks, [enable VPN connection](../manual/larepass/private-network.md) in LarePass for your streaming device. Devices with activated VPN will use the VPN connection to access Olares, whether through the LarePass client or a browser. :::tip For different LarePass download options, visit [the official page](https://olares.com/larepass). ::: -Once enabled, you can also access your applications using the format: `https://[RouteID].local.[OlaresDomainName]`. - -Devices with activated VPN will use the VPN connection to access Olares, whether through the LarePass client or a browser. - ## Access media files in LarePass After enabling VPN, you can browse media files stored on Olares. @@ -32,7 +28,7 @@ After enabling VPN, you can browse media files stored on Olares. 2. Click on any file to start playback on your computer or mobile device. ### Access from browser -1. Open files from your Olares desktop, or directly using the local address: `https://files.local.[OlaresDomainName]`. +1. Open files from your Olares desktop, or directly using the app's URL: `https://files.[OlaresDomainName]`. 2. Locate your media directory, and click on video files to begin playback. ## Access media files using Jellyfin diff --git a/docs/zh/developer/develop/advanced/cookie.md b/docs/zh/developer/develop/advanced/cookie.md index a87146df..5175483f 100644 --- a/docs/zh/developer/develop/advanced/cookie.md +++ b/docs/zh/developer/develop/advanced/cookie.md @@ -14,8 +14,6 @@ Olares 系统中采用 SSO 的模式来为整个系统(包括所有安装的 为避免 cookie 冲突,任何应用(包括系统的内建应用,三方应用)都不可以设置 cookie 到用户的域,只可设置到应用自己的域下面。 -由于系统的每个 APP 都存在两个域名 `..olares.com` 和 `.local..olares.com`。所以 Olares 在 Olares 应用运行时中整合了 cookie 设置 `rewrite`机制,确保应用自动为 HTTP Response 中 Set-Cookie 字段中的两个域分配 cookie。 - 要使用这个功能只需要在应用 chart 的 [OlaresManifest.yaml](../package/manifest.md#resetcookie) 中申明: ```yaml diff --git a/docs/zh/developer/develop/package/manifest.md b/docs/zh/developer/develop/package/manifest.md index 7cb25e98..495eac26 100644 --- a/docs/zh/developer/develop/package/manifest.md +++ b/docs/zh/developer/develop/package/manifest.md @@ -311,10 +311,10 @@ ports: ``` ::: -Olares 会自动为你的应用分配一个 33333-36789 之间的随机端口。这些端口可通过应用域名在本地网络下访问。例如:`84864c1f.local.your_olares_id.olares.com:33805`。 +Olares 会自动为你的应用分配一个 33333-36789 之间的随机端口。这些端口可通过应用域名访问。例如:`84864c1f.your_olares_id.olares.com:33805`。 :::info 提示 -暴露的端口只能通过本地网络或 Olares 专用网络访问。 +暴露的端口只能通过 LarePass 专用网络访问。 ::: ## Permission diff --git a/docs/zh/manual/concepts/network.md b/docs/zh/manual/concepts/network.md index 9c163cf8..0b7bf3b0 100644 --- a/docs/zh/manual/concepts/network.md +++ b/docs/zh/manual/concepts/network.md @@ -23,11 +23,16 @@ Olares 为用户提供无障碍且安全灵活的网络解决方案。本文档 - **内部入口** - 和私有入口类似 - - 设备通过本地网络或者 Olares 专用网络访问应用时无需鉴权 + - 设备 LarePass 专用网络访问应用时无需鉴权 -## 通过 local 访问 +## 通过 LarePass 专用网络访问私有入口 -在局域网内或使用[专用网络](../larepass/private-network.md)访问 Olares 上的应用时,可以在应用 URL 中加上 `.local` 字段,以获取更快的访问速度。例如,`https://vault.local.alice123.olares.cn`。 +只需在设备上安装 LarePass,并启用专用网络 (/manual/larepass/private-network.md),即可通过专属网址(如 +https://vault.alice123.olares.com)安全、快速地访问您的私有应用。 + +::: tip 注意 +如不启用 LarePass 专用网络,私有入口的请求会通过你的反向代理通道到达 Olares,可能会有网络延迟并产生费用。 +::: ## 端点 diff --git a/docs/zh/manual/get-started/next-steps.md b/docs/zh/manual/get-started/next-steps.md index acac33e6..8122c76d 100644 --- a/docs/zh/manual/get-started/next-steps.md +++ b/docs/zh/manual/get-started/next-steps.md @@ -44,7 +44,7 @@ description: Olares 新手上路指南,包括系统初始配置、基础功能 description="使用 LarePass 客户端管理你的帐户、VPN、设备等。" :links="[ { text: '管理帐户', href: '../larepass/create-account' }, - { text: '启用 VPN', href: '../larepass/private-network' }, + { text: '启用专用网络', href: '../larepass/private-network' }, { text: '管理设备', href: '../larepass/manage-device' }, { text: '同步文件', href: '../larepass/sync-share' }, { text: '收集内容', href: '../larepass/manage-knowledge'}, diff --git a/docs/zh/manual/larepass/private-network.md b/docs/zh/manual/larepass/private-network.md index 5cce23c1..005836ea 100644 --- a/docs/zh/manual/larepass/private-network.md +++ b/docs/zh/manual/larepass/private-network.md @@ -2,17 +2,34 @@ outline: [2, 3] description: 使用 LarePass 专用网络从任何地点安全访问 Olares。了解专用网络的启用方法以及常见故障排查。 --- +# 通过专用网络随时随地访问 Olares -# 通过 LarePass 专用网络随时随地访问 Olares +启用 LarePass 专用网络会创建一个安全的专用通道,让你随时随地安全、快速访问你运行在 Olares 上的应用和服务。 -启用专用网络后,设备与 Olares 之间的所有流量都会经过一条安全的专用通道传输,带来与本地访问相同的体验。 +本文将介绍如何在不同设备上启用 LarePass 专用网络。 -本文介绍如何在 LarePass 中设置专用网络,以便随时随地连接到 Olares。 + +## 了解 Olares 上的应用访问 + +在 Olares 中,您可以通过专属网址(`app.yourname.olares.com`)访问应用和服务。根据应用的访问属性,入口可分为两种类型: + +* 公共入口 (Public entrance): 无需身份验证即可供任何人访问。例如,你托管在 WordPress 上的博客页面。流量在到达 Olares 之前会通过 Cloudflare Tunnel 或 FRP 进行路由转发。 +* 私有入口 (Private entrance): 仅供你个人使用,例如访问您的桌面、Vault 或 WordPress 管理后台等服务。访问私有入口时存在两种情况: + * 启用 LarePass 专用网络时: 无论你身在何处,流量都将通过基于 Tailscale 的专用网络到达 Olares。 + * 未启用 LarePass 专用网络时: 流量的路由方式与公共入口相同。 + +::: warning 始终启用 LarePass 专用网络 +为获得最佳体验,我们强烈建议你在访问 Olares 时启用 LarePass 专用网络。这能确保你对应用的连接始终保持安全、高效。 +::: + +::: tip 注意 +从 Olares 1.12 版本开始,你不再需要为本地访问使用单独的 `.local` 地址 (如 `app.local.yourname.olares.cn`)。只要 LarePass 专用网络处于激活状态,你的唯一应用地址 (`app.yourname.olares.cn`)会自动为你提供快速、安全的连接。 +::: ## 在 LarePass 中启用专用网络 ::: tip -查看各平台安装包,请访问 [官方下载页面](https://olares.com/larepass)。 +查看各平台安装包,请访问[官方下载页面](https://olares.com/larepass)。 ::: ![VPN](/images/manual/larepass/vpn.jpg) diff --git a/docs/zh/manual/olares/settings/custom-app-domain.md b/docs/zh/manual/olares/settings/custom-app-domain.md index 255c260b..f5dc8efd 100644 --- a/docs/zh/manual/olares/settings/custom-app-domain.md +++ b/docs/zh/manual/olares/settings/custom-app-domain.md @@ -21,11 +21,7 @@ Olares 提供两种方法来优化应用的访问地址: ### 自定义路由 ID 路由 ID 是访问 Olares 应用的重要组成部分,和 Olares 域名一起构成了你通过 Web 浏览器访问应用的 URL: -`https://{routeID}.local.{OlaresDomainName}` - -::: info Local 访问 -URL 中的 `local` 表示这是一个私有访问入口,通常用于为个人用户、家庭或团队提供服务的应用。面向公众的应用不会包含 `local`。更多详情,请参阅 [入口](../../concepts/network.md#入口)。 -::: +`https://{routeID}.{OlaresDomainName}` 为方便起见,Olares 为预安装的系统应用使用了易于记忆的路由 ID。对于社区应用,你可以通过更改路由 ID 快速获得一个简单易记的 URL。 @@ -40,7 +36,7 @@ URL 中的 `local` 表示这是一个私有访问入口,通常用于为个人 ![自定义路由 ID](/images/zh/manual/tasks/custom-route-id.png#bordered) 6. 点击**确认**。 -现在,你可以通过新的 URL 访问 Jellyfin:`https://jellyfin.local.bob.olares.cn`。 +现在,你可以通过新的 URL 访问 Jellyfin:`https://jellyfin.bob.olares.cn`。 ### 自定义域名 diff --git a/docs/zh/use-cases/comfyui-for-krita.md b/docs/zh/use-cases/comfyui-for-krita.md index 0b54c2c0..fd76ea7e 100644 --- a/docs/zh/use-cases/comfyui-for-krita.md +++ b/docs/zh/use-cases/comfyui-for-krita.md @@ -47,12 +47,9 @@ description: 将 ComfyUI 与 Krita 结合使用的教程,学习如何配置 AI 4. 从桌面启动 ComfyUI,通过生成测试图像验证安装是否成功。 5. 复制 ComfyUI 地址,以备后续使用。 :::tip - 出于安全考虑,应始终在局域网中运行 AI 应用。正确配置后,ComfyUI 的 URL 中应包含“`.local`”字段。 - 如果缺少“`.local`”,请检查本地网络环境,确保当前设备和 Olares 处于同一网段,并且未启用外部网络代理服务。 - ::: - :::tip - 如果你需要在外网远程使用 Olares 上的 AI 应用,可以使用 LarePass 的专用网络功能,详见[通过专用网络随时随地访问 Olares 应用](../manual/larepass/private-network.md)。 + 出于安全考虑,应始终在 [LarePass 专用网络](../manual/larepass/private-network.md)激活时运行 AI 应用。 ::: + ## 配置 Krita 1. 下载 [Krita](https://krita.org/en/download/)。 @@ -88,6 +85,7 @@ description: 将 ComfyUI 与 Krita 结合使用的教程,学习如何配置 AI 如果连接失败: - 检查计算机与 Olares 主机是否处于同一网段。如果不在同一网络下,是否已成功开启专用网络功能(网络状态显示为“P2P”或“DERP”)。 - 检查 ComfyUI 的认证级别是否设为“内部”。 + - 检查 LarePass 专用网络是否开启。 - 检查计算机是否开启了网络代理服务。如果开启,手动关闭后再重试。 - 检查 ComfyUI 在 Olares 主机上是否能正常生成图片。 ::: diff --git a/docs/zh/use-cases/dify.md b/docs/zh/use-cases/dify.md index 436ba592..f4855941 100644 --- a/docs/zh/use-cases/dify.md +++ b/docs/zh/use-cases/dify.md @@ -9,6 +9,7 @@ Dify 是一个 AI 应用开发平台。它是 Olares 集成的关键开源项目 要使用本地 AI 模型,请确保你的环境中已配置以下内容: - Olares 环境中已安装并运行 [Ollama](ollama.md)。 - 已安装 [Open WebUI](openwebui.md),并下载了你偏好的语言模型。 +- 访问设备已安装 LarePass 并已[启用专用网络](../manual/larepass/private-network.md)。 :::tip 提示 建议使用 `gemma2` 或 `qwen` 等轻量但功能强大的模型,可在速度和性能间取得良好平衡。 ::: @@ -37,7 +38,7 @@ Dify 是一个 AI 应用开发平台。它是 Olares 集成的关键开源项目 2. 在 Dify 的 模型提供者商配置页面,选择 Ollama 作为模型提供者商,并进行以下配置: - **模型名称**:填写模型名称,例如:`gemma2`。 - - **基础 URL**:填入 Ollama 本地地址: `https://39975b9a1.local.{username}.olares.cn`。将 `{username}` 替换为 Olares 管理员的用户名。例如:`https://39975b9a1.local.marvin123.olares.com`。 + - **基础 URL**:填入 Ollama 本地地址: `https://39975b9a1.{username}.olares.cn`。将 `{username}` 替换为 Olares 管理员的用户名。例如:`https://39975b9a1.marvin123.olares.com`。 ![配置 Ollama](/images/zh/manual/use-cases/dify-add-gemma2.png#bordered){width=70%} diff --git a/docs/zh/use-cases/host-cloud-android.md b/docs/zh/use-cases/host-cloud-android.md index 0004a6d6..db0bcee2 100644 --- a/docs/zh/use-cases/host-cloud-android.md +++ b/docs/zh/use-cases/host-cloud-android.md @@ -25,9 +25,7 @@ description: 在 Olares 上部署云端 Android 模拟器 redorid,并在 Mac - redroid 运行时会消耗较高系统资源。为获得更佳性能,建议使用至少 8 核 CPU 和 16GB 内存的主机运行 Olares。 ::: -- 连接设备和 Olares 处于同一局域网。 - ::: tip 远程连接 - 如连接设备和 Olares 在不同网络,需要在设备上安装 LarePass 客户端以启用专用网络。可在 [LarePass 官网](https://olares.cn/larepass)下载正确的版本。 +- 在连接设备上安装 LarePass 客户端并启用[专用网络](../manual/larepass/private-network.md)。可在 [LarePass 官网](https://olares.cn/larepass)下载正确的版本。 ## 安装内核依赖模块 @@ -55,7 +53,7 @@ redroid 在 Olares 上以无界面的服务后端运行。要安装 redroid: c. 将 redroid 对外服务端口 `46878` 附在基础域名后。 - 因为 redroid 服务仅支持本地模式访问,需要在 URL 里加入 `local` 关键字。这样,我们就得到了 redroid 的对外服务网址,如 `beb583c3.local.olares01.olares.cn:46878`。 + 这样,我们就得到了 redroid 的对外服务网址,如 `beb583c3.olares01.olares.cn:46878`。 ## 连接 redroid 服务 @@ -82,20 +80,20 @@ Windows 版本的 `scrcpy` 集成了 `adb` 工具,不用另行安装。 ```powershell # 请将 替换为你自己的 Olares ID - .\adb.exe connect beb583c3.local..olares.cn:46878 + .\adb.exe connect beb583c3..olares.cn:46878 ``` 连接成功会看到示例中的消息提示: ```powershell # 示例输出 - already connected to beb583c3.local..olares.cn:46878 + already connected to beb583c3..olares.cn:46878 ``` 4. 用 `scrcpy` 渲染界面和音频: ```powershell - .\scrcpy.exe -s beb583c3.local.harvey063.olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder + .\scrcpy.exe -s beb583c3.harvey063.olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder ``` 执行成功后,命令行会输出连接设备信息,同时在桌面弹出安卓屏幕。 @@ -135,7 +133,7 @@ macOS 版本 `scrcpy` 没有集成 `adb`,需要你单独安装。推荐使用 ```bash # 请将 替换为你自己的 Olares ID - adb connect beb583c3.local..olares.cn:46878 + adb connect beb583c3..olares.cn:46878 ``` 看到示例输出即代表服务连接成功: @@ -143,13 +141,13 @@ macOS 版本 `scrcpy` 没有集成 `adb`,需要你单独安装。推荐使用 ```bash ```bash # 示例输出 - already connected to beb583c3.local..olares.cn:46878 + already connected to beb583c3..olares.cn:46878 ``` 4. 用 `scrcpy` 渲染界面和音频: ```bash - scrcpy -s beb583c3.local..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder + scrcpy -s beb583c3..olares.cn:46878 --audio-codec=aac --audio-encoder=OMX.google.aac.encoder ``` 执行成功后,命令行会输出连接设备信息,同时在桌面弹出安卓屏幕。 @@ -176,7 +174,7 @@ macOS 版本 `scrcpy` 没有集成 `adb`,需要你单独安装。推荐使用 ```powershell # 示例输出 List of devices attached - beb583c3.local.olares02.olares.cn:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 + beb583c3.olares02.olares.cn:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 ``` 2. 在指定设备上安装 apk 应用,需通过 `-t` 参数指定 `transport_id`: @@ -204,7 +202,7 @@ macOS 版本 `scrcpy` 没有集成 `adb`,需要你单独安装。推荐使用 ```bash # 示例输出 List of devices attached - beb583c3.local.olares02.olares.cn:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 + beb583c3.olares02.olares.cn:46878 device product:ziyi model:23031PN0DC device:ziyi transport_id:4 ``` diff --git a/docs/zh/use-cases/ollama.md b/docs/zh/use-cases/ollama.md index bbccbc84..17ed3906 100644 --- a/docs/zh/use-cases/ollama.md +++ b/docs/zh/use-cases/ollama.md @@ -11,6 +11,7 @@ Ollama 是一个轻量级平台,可以让你在本地机器上直接运行 `de ## 开始之前 请确保满足以下条件: - 当前登录账号为 Olares 管理员。 +- 确保设备已安装 LarePass 并[启用专用网络](../manual/larepass/private-network.md#在-larepass-中启用专用网络)。 ## 安装 Ollama diff --git a/docs/zh/use-cases/openwebui.md b/docs/zh/use-cases/openwebui.md index 2e9ae9ca..7876482a 100644 --- a/docs/zh/use-cases/openwebui.md +++ b/docs/zh/use-cases/openwebui.md @@ -11,6 +11,10 @@ Open WebUI 为大语言模型(LLM)提供了直观的管理界面,支持 Ol * 语音交互(语音转文字和文字转语音) * 图像生成功能 +:::tip 打开 LarePass 专用网络 +确保访问设备已安装 LarePass 并 [启用专用网络](../manual/larepass/private-network.md#在-larepass-中启用专用网络)以确保安全、流畅的访问体验。 +::: + ## 安装 Ollama 和 Open WebUI 使用 Open WebUI 前需要先安装 Ollama: * **管理员**:需要同时安装“Ollama”和“Open WebUI”。 diff --git a/docs/zh/use-cases/perplexica.md b/docs/zh/use-cases/perplexica.md index 3280405e..0163e481 100644 --- a/docs/zh/use-cases/perplexica.md +++ b/docs/zh/use-cases/perplexica.md @@ -20,6 +20,7 @@ SearXNG 作为 Perplexica 的后端,是一个注重隐私的元搜索引擎。 :::tip 建议使用 `gemma2` 等轻量但功能强大的模型,可在速度和性能间取得良好平衡。 ::: +- 确保访问设备已安装 LarePass 并[启用专用网络](../manual/larepass/private-network.md#在-larepass-中启用专用网络)。 ## 配置 Perplexica 1. 管理员从应用市场安装 SearXNG。 diff --git a/docs/zh/use-cases/stream-game.md b/docs/zh/use-cases/stream-game.md index 6fdf7c4d..b8e321ab 100644 --- a/docs/zh/use-cases/stream-game.md +++ b/docs/zh/use-cases/stream-game.md @@ -21,10 +21,7 @@ description: 在 Olares 上安装 Steam Headless,配置串流服务,并使 开始前,请确保以下条件已满足: - Olares 已在配有 NVIDIA 显卡的主机上运行。 - 串流设备已安装 Moonlight 客户端。可访问 [Moonlight 官网](https://moonlight-stream.org/)下载适合你设备的客户端并安装。 -- 你的串流设备和 Olares 处于同一个局域网。 - :::tip 远程串流 - 如需远程串流,你需要提前在串流设备上安装 LarePass 客户端。请在 [LarePass 官网](https://olares.cn/larepass)上下载对应的版本。 - ::: +- 确保串流设备已安装 LarePass 并[启用专用网络](../manual/larepass/private-network.md#在-larepass-中启用专用网络)。 - 拥有一个有效的 Steam 账号以访问你的游戏。 ## 安装 Steam Headless @@ -57,7 +54,7 @@ Steam Headless 集成了 Sunshine 串流服务器。要使用 Moonlight 客户 ### 准备配对 -1. 从浏览器获取 Steam Headless 页面的 URL,并添加端口号 `:47990`,如 `https://139ebc4f0.local.<你的olares ID>.olares.cn:47990`。通过该网址访问 Sunshine 串流服务器的控制页面。 +1. 从浏览器获取 Steam Headless 页面的 URL,并添加端口号 `:47990`,如 `https://139ebc4f0.<你的olares ID>.olares.cn:47990`。通过该网址访问 Sunshine 串流服务器的控制页面。 ![Sunshine 控制台](/images/manual/tutorials/access-sunshine.png#bordered) @@ -71,10 +68,10 @@ Steam Headless 集成了 Sunshine 串流服务器。要使用 Moonlight 客户 ### 在 Moonlight 端添加主机 1. 在串流设备上打开 Moonlight 客户端,点击右上角 add_to_queue 按钮添加主机。 -2. 输入主机 IP 地址,即 Steam 的本地 URL:`139ebc4f0.local.<你的olares ID>.olares.cn`。 +2. 输入主机 IP 地址,即 Steam 的本地 URL:`139ebc4f0.<你的olares ID>.olares.cn`。 ::: tip 注意 - 仅需填入 URL 部分(无需 `https://`),要包含 `local` 关键词。 + 仅需填入 URL 部分(无需 `https://`)。 ::: 3. 点击**确定**,界面上会出现一个锁定状态的主机图标。 diff --git a/docs/zh/use-cases/stream-media.md b/docs/zh/use-cases/stream-media.md index f092821e..30384d12 100644 --- a/docs/zh/use-cases/stream-media.md +++ b/docs/zh/use-cases/stream-media.md @@ -12,7 +12,8 @@ description: 通过 Olares 搭建私人流媒体服务器,配置 VPN 远程访 - 安装和设置 Jellyfin 以实现串流。 ## 打开 Olares 专用网络 -为了在外部网络中实现流畅的流媒体播放,需要在 LarePass 中启用 Olares 专用网络。这可以确保安装了 LarePass 的设备通过专用网络传输所有流量,从而提供类似局域网的速度和性能。 +为了在不同网络中实现流畅的流媒体播放,需要在 LarePass 中[启用专用网络](../manual/larepass/private-network.md#在-larepass-中启用专用网络)。 +启用专用网络的设备无论是通过 LarePass 客户端还是浏览器访问 Olares,都会使用专用网络连接。 :::tip 如需下载不同版本的 LarePass,请访问[官方页面](https://olares.cn/larepass)。 @@ -20,10 +21,6 @@ description: 通过 Olares 搭建私人流媒体服务器,配置 VPN 远程访 -开启后,你还可以通过以下格式访问应用:`https://[RouteID].local.[OlaresDomainName]`。 - -启用专用网络的设备无论是通过 LarePass 客户端还是浏览器访问 Olares,都会使用专用网络连接。 - ## 在 LarePass 中访问媒体文件 启用专用网络后,你可以浏览存储在 Olares 上的媒体文件。 @@ -34,7 +31,7 @@ description: 通过 Olares 搭建私人流媒体服务器,配置 VPN 远程访 ![在 LarePass 客户端中播放视频](/images/zh/manual/use-cases/view-video-from-larepass-desktop.png#bordered) ### 通过浏览器访问 -1. 以网页模式打开**文件管理器**,或者直接使用本地地址:`https://files.local.[OlaresDomainName]`。 +1. 以网页模式打开**文件管理器**,或者直接使用其 URL:`https://files.[OlaresDomainName]`。 ![打开文件管理器](/images/zh/manual/use-cases/view-video-from-files.png#bordered) 2. 找到你的媒体目录,点击视频文件即可开始播放。