文档

网页端

部署 Olived Web 应用

Olived 不仅有桌面端版本,还可以作为 Web 应用程序进行部署,让您可以直接通过网页浏览器访问其各项功能。本指南将介绍两种部署方法:使用预编译的可执行文件,或者使用 Docker。

使用可执行文件

此方法使用适用于您操作系统的独立可执行文件。

  1. 下载并运行:

  2. macOS 用户: 如果您使用的是 macOS,则需要在运行可执行文件之前授予执行权限。打开“终端”并执行以下命令,请确保将 /path/to/OlivedPro_web 替换为下载应用程序的实际文件路径:

    sudo xattr -r -d com.apple.quarantine /path/to/OlivedPro_web
  3. 访问 Olived: 可执行文件运行后,打开您的浏览器并访问 http://localhost:9843/

使用 Docker

使用 Docker 是快速启动并运行 Olived 的推荐方式。我们提供两种方法:使用 Docker Compose(推荐,更简单)或使用基础的 docker run 命令。

先决条件

在开始之前,请确保您的系统上已经安装了 DockerDocker Compose

1. 使用 docker-compose.yml 快速开始 (推荐)

这是管理您的 Olived 容器最简单的方式。

第一步:创建 docker-compose.yml 文件

创建一个名为 docker-compose.yml 的文件,并将以下内容粘贴进去:

services:
  olived:
    image: olivedapp/olived-web:latest
    container_name: olived-web
    pull_policy: always
    restart: unless-stopped
    ports:
      # 将 Web UI 的 9843 端口暴露出来。通过 http://<您的主机IP>:9843 访问
      - "9843:9843"
    environment:
      # 设置用户ID和组ID,以避免卷挂载时的文件权限问题
      # 您可以通过运行命令 `id $(whoami)` 来找到您当前用户的 PUID 和 PGID
      - PUID=1000
      - PGID=1000
      # (可选) 设置您的时区,以确保应用内的时间戳正确
      # 您可以在这里找到时区列表: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
      - TZ=Asia/Shanghai
    volumes:
      - $PWD/olivedpro_downloads:/olivedapp/olivedpro_downloads # 映射下载文件夹
      - $PWD/.olivedpro:/olivedapp/.olivedpro # 映射配置文件夹

第二步:启动容器

在您的 docker-compose.yml 文件所在的目录中,打开终端并运行:

docker compose up -d

就这样!Olived 现在已经成功运行。您可以通过浏览器访问 http://<您的服务器IP>:9843 来使用 Web 界面。

2. 备用方案:使用 docker run

如果您不想使用 Docker Compose,也可以使用下面的 docker run 命令。

docker run -d \
  --name olived-web \
  --restart unless-stopped \
  --pull always \
  -p 9843:9843 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Asia/Shanghai \
  -v $PWD/olivedpro_downloads:/olivedapp/olivedpro_downloads \
  -v $PWD/.olivedpro:/olivedapp/.olivedpro \
  olivedapp/olived-web:latest

配置与参数详解

环境变量 (-e)

  • PUID=1000 & PGID=1000: 这两个参数对于避免宿主机与容器之间的文件权限错误至关重要。要找到您自己的用户ID和组ID,请运行 id $(whoami) 命令。
    • 示例输出: uid=1000(myuser) gid=1000(myuser) groups=1000(myuser)
    • 在这个例子中,您就应该使用 PUID=1000PGID=1000
  • TZ=Asia/Shanghai: (可选,但推荐) 设置容器内部的时区。这能确保您录制视频的时间戳是准确的。您可以从这个列表中找到您所在的时区 (例如, Asia/Shanghai)。

卷挂载 (-v)

卷(Volume)的作用是将您宿主机上的一个目录映射到容器内部的一个目录。这对于持久化保存您的数据至关重要。即使您删除了容器,您的数据依然会安全地保留在宿主机上。

  • $PWD/.olivedpro:/olivedapp/.olivedpro: 这会将您当前目录下的一个名为 .olivedpro 的隐藏文件夹映射到容器内部的配置路径。这是最重要的需要备份的卷。
  • $PWD/olivedpro_downloads:/olivedapp/olivedpro_downloads: 这会将您当前目录下的 olivedpro_downloads 文件夹映射到Olived保存录制视频的地方。

On this page