使用 Docker

在开始之前，请确保你的系统上已经安装了 Docker

快速开始

Docker

拉取镜像

从 GitHub Container Registry 拉取 OpenFic 镜像：

docker pull ghcr.io/syrizelink/openfic:latest

启动容器

docker run -d -p 8000:8000 -v "openfic:/data" \
	--name openfic --restart unless-stopped \
	ghcr.io/syrizelink/openfic:latest

参数	用途
`-d`	在后台运行容器。
`-p 8000:8000`	将主机的`8000`端口映射到容器的`8000`端口。
`-v "openfic:/data"`	持久化存储，将名为`openfic`的 Docker 数据卷挂载到容器的`/data`，以防止重启后丢失数据
`--name openfic`	为容器命名
`--restart unless-stopped`	Docker 服务重启后自动启动 OpenFic，除非你手动停止了容器。

打开 OpenFic

容器启动后，在浏览器中打开 http://localhost:8000。如你在云服务器上运行，请将localhost替换为服务器的公网IP，并在防火墙放行8000端口。

Docker Compose

编写配置文件

以下是使用 Docker Compose 的示例配置文件docker-compose.yml：

services:
  openfic:
    image: ghcr.io/syrizelink/openfic:latest
    ports:
      - "8000:8000"
    volumes:
      - openfic:/data
    restart: unless-stopped

volumes:
  openfic:

也可以从 Github 下载示例的配置文件。

启动服务

docker compose up -d

打开 OpenFic

容器启动后，在浏览器中打开 http://localhost:8000。

常用配置

自定义端口

如果主机的8000端口已经被占用，或你希望使用其它端口，可以只修改端口映射。例如，下面的命令会通过主机的8080端口访问 OpenFic：

docker run -d -p 8080:8000 -v "openfic:/data" \
	--name openfic --restart unless-stopped \
	ghcr.io/syrizelink/openfic:latest

然后打开 http://localhost:8080。

保存数据至本地目录

默认命令使用 Docker named volume 进行数据持久化，你也可以将主机目录挂载到/data：

docker run -d -p 8000:8000 -v "/absolute/path/to/openfic-data:/data" \
	--name openfic --restart unless-stopped \
	ghcr.io/syrizelink/openfic:latest

将/absolute/path/to/openfic-data替换为主机上的实际目录，请确保 Docker 对该目录具有读写权限。

固定版本

OpenFic 遵循 Semantic Versioning 的版本号发布规范，你可以使用如:X.Y.Z的版本标签拉取特定版本的镜像，在 Package Versions 可以查询到所有可用的版本号。

docker run -d -p 8000:8000 -v "openfic:/data" \
	--name openfic --restart unless-stopped \
	ghcr.io/syrizelink/openfic:X.Y.Z

将:X.Y.Z替换为你需要固定的版本号，这会将容器锁定在选定的版本，并且永远不会更改。

更新

自动更新

要使用自动更新，请确保容器使用的镜像标签是latest而非固定版本。你可以使用 Watchtower 自动处理更新过程：

docker run --rm \
	-v /var/run/docker.sock:/var/run/docker.sock \
	nickfedor/watchtower --run-once openfic

如果你使用了自定义名称，请将openfic替换为实际使用的容器名。如果需要启用定时检查并自动更新，请启动一个保持运行的 Watchtower 容器：

docker run -d \
	  --name openfic-watchtower --restart unless-stopped \
	  -v /var/run/docker.sock:/var/run/docker.sock \
	  nickfedor/watchtower --interval 86400 openfic

该容器会每隔 86400s(24h) 检查一次更新。如果需要定点更新，可以将命令中的--interval 86400改为使用 Cron 表达式：例如，可以使用--schedule "0 3 * * *" 指定在每天凌晨 3:00 检查并处理自动更新如果想在更新后自动删除旧镜像以节省空间，可以加上--cleanup参数：例如：--schedule "0 4 * * *" --cleanup

手动更新

停止并删除当前容器

docker rm -f openfic

拉取最新版本

docker pull ghcr.io/syrizelink/openfic:latest

重启容器

docker run -d -p 8000:8000 -v "openfic:/data" \
	--name openfic --restart unless-stopped \
	ghcr.io/syrizelink/openfic:latest

如果你使用了自定义端口或本地目录，请在重新创建容器时保留对应的-p和-v参数。

卸载

停止并删除当前容器

docker rm -f openfic

删除本地镜像（可选）

docker image rm ghcr.io/syrizelink/openfic:latest

删除数据卷（可选）

docker volume rm openfic

安装

快速入门

功能

快速开始

Docker

Docker Compose

常用配置

自定义端口

保存数据至本地目录

固定版本

更新

自动更新

手动更新

卸载

​快速开始

​Docker

​Docker Compose

​常用配置

​自定义端口

​保存数据至本地目录

​固定版本

​更新

​自动更新

​手动更新

​卸载

快速开始

Docker

Docker Compose

常用配置

自定义端口

保存数据至本地目录

固定版本

更新

自动更新

手动更新

卸载