Docker 安装指南

说明

本指南假设您在非 root（非管理员）文件夹中安装 SillyTavern。如果您在 root 文件夹中安装 SillyTavern，您可能需要使用管理员权限运行某些命令[sudo、doas、Command Prompt (Administrator)]。

:beer: 不想折腾 Docker？试试一键启动器

Docker 很强大，但如果你只是想在本地流畅玩酒馆，一键启动器更省心 — 零依赖、原生运行、自动更新。

:arrow_right: 下载一键启动器

安装

Linux

请按照此处的 Docker 安装指南安装 Docker。

重要提示
不要安装 Docker Desktop。
按照 Docker 安装后配置指南中的以非 root 用户身份管理 Docker部分进行操作。
使用包管理器安装 Git。
- Debian (Ubuntu/Pop! OS/等)
```
sudo apt install git
```
- Arch Linux (Manjaro/EndeavourOS/等)
```
sudo pacman -S git
```
- Fedora, Red Hat Enterprise Linux (RHEL), 等
```
sudo dnf install git
```

克隆 SillyTavern 仓库。

Release (稳定分支)

git clone https://github.com/SillyTavern/SillyTavern && cd SillyTavern/docker

Staging (开发分支)

git clone https://github.com/SillyTavern/SillyTavern -b staging && cd SillyTavern/docker

在 Docker 文件夹中运行以下命令执行 docker compose。
```
docker compose up -d
```

执行以下 Docker 命令获取 SillyTavern Docker 容器的 IP 地址。

docker network inspect docker_default

您应该会看到类似下面的输出：

[
    {
        "Name": "docker_default",
        "IPAM": {
            "Config": [
                {
                    "Subnet": "172.18.0.0/16",
                    "Gateway": "172.18.0.1"
                }
            ]
        }
    }
]

记下您在 Gateway 中看到的 IP 地址，这很重要。

使用 sudo 打开 nano 并运行以下命令：
```
sudo nano config/config.yaml
```
在 nano 中，找到 whitelist。您应该会看到类似下面的内容：
```
whitelist:
    - 127.0.0.1
```
在 127.0.0.1 下面添加一行，输入您从 Docker 复制的 IP 地址。完成后应该类似这样：
```
whitelist:
    - 127.0.0.1
    - 172.18.0.1
```
按 Ctrl+S 保存文件，然后按 Ctrl+X 退出 nano。

!!! info 注意，如果您将 Docker 网络配置为桥接模式，您也可以像往常一样将外部 IP 地址添加到白名单中。 !!!
重启 Docker 容器以应用新配置。
```
docker compose restart sillytavern
```
打开新的浏览器并访问 http://localhost:8000。几分钟后您应该就能看到 SillyTavern 加载完成。
尽情享用！ :D

Windows

关于 Windows 上的 Docker

在 Windows 上使用 Docker 非常复杂。您不仅需要在"启用或关闭 Windows 功能"中激活 Windows Subsystem for Linux，还需要为虚拟化配置系统（Intel VT-d/AMD SVM），这因 PC 制造商（或主板制造商）而异。有时，某些系统上甚至没有这个选项。

强烈建议您按照我们的 Windows 指南安装 SillyTavern。本节仅是在 Windows 上安装的一个_粗略_思路。

按照此处的 Docker 安装指南安装 Docker Desktop。
安装 Git for Windows。

克隆 SillyTavern 仓库。

Release (稳定分支)

git clone https://github.com/SillyTavern/SillyTavern && cd SillyTavern/docker

Staging (开发分支)

git clone https://github.com/SillyTavern/SillyTavern -b staging && cd SillyTavern/docker

在 Docker 文件夹中运行以下命令执行 docker compose。
```
docker compose up -d
```

执行以下 Docker 命令获取 SillyTavern Docker 容器的 IP 地址。

docker network inspect docker_default

您应该会看到类似下面的输出：

[
    {
        "Name": "docker_default",
        "IPAM": {
            "Config": [
                {
                    "Subnet": "172.18.0.0/16",
                    "Gateway": "172.18.0.1"
                }
            ]
        }
    }
]

记下您在 Gateway 中看到的 IP 地址，这很重要。

以管理员权限运行 Notepad 或您选择的代码编辑器，进入 config 目录并打开 config.yaml。

在您选择的编辑器中，您应该会看到类似下面的内容：
```
whitelist:
    - 127.0.0.1
```
在 127.0.0.1 下面添加一行，输入您从 Docker 复制的 IP 地址。完成后应该类似这样：
```
whitelist:
    - 127.0.0.1
    - 172.18.0.1
```
按 Ctrl+S 保存文件，然后退出编辑器。

说明
注意，如果您将 Docker 网络配置为桥接模式，您也可以像往常一样将外部 IP 地址添加到白名单中。
重启 Docker 容器以应用新配置。
```
docker compose restart sillytavern
```
打开新的浏览器并访问 http://localhost:8000。几分钟后您应该就能看到 SillyTavern 加载完成。
尽情享用！ :D

macOS

尽管 macOS 与 Linux 类似，但它没有 Docker Engine。您需要像 Windows 一样安装 Docker Desktop。您还需要安装 Homebrew 以在 Mac 上安装 Git。本节仅是在 macOS 上安装的一个_粗略_思路。

按照此处的 Docker 安装指南安装 Docker Desktop。
使用 Homebrew 安装 git。
```
brew install git
```

克隆 SillyTavern 仓库。

Release (稳定分支)

git clone https://github.com/SillyTavern/SillyTavern && cd SillyTavern/docker

Staging (开发分支)

git clone https://github.com/SillyTavern/SillyTavern -b staging && cd SillyTavern/docker

在 Docker 文件夹中运行以下命令执行 docker compose。
```
docker compose up -d
```

执行以下 Docker 命令获取 SillyTavern Docker 容器的 IP 地址。

docker network inspect docker_default

您应该会看到类似下面的输出：

[
    {
        "Name": "docker_default",
        "IPAM": {
            "Config": [
                {
                    "Subnet": "172.18.0.0/16",
                    "Gateway": "172.18.0.1"
                }
            ]
        }
    }
]

记下您在 Gateway 中看到的 IP 地址，这很重要。

使用 sudo 打开 nano 并运行以下命令。
```
sudo nano config/config.yaml
```
如果无法运行 nano，请通过 Homebrew 安装，或改用 TextEdit。

在 nano 中向下找到 whitelist，你应该会看到类似下面的内容。
```
whitelist:
    - 127.0.0.1
```
在 127.0.0.1 下面新增一行，填入从 Docker 复制的 IP 地址。完成后应类似如下。
```
whitelist:
    - 127.0.0.1
    - 172.18.0.1
```
按 Ctrl+S 保存文件，然后按 Ctrl+X 退出 nano。

说明
注意：如果你将 Docker 网络配置为 bridge 模式，也可以像平时一样把外部 IP 地址加入白名单。
重启 Docker 容器以应用新配置。
```
docker compose restart sillytavern
```
打开一个新浏览器并访问 http://localhost:8000。稍等片刻即可看到 SillyTavern 加载完成。
享受吧！:D

配置 SillyTavern

SillyTavern 的配置文件（config.yaml）位于 config 文件夹内。配置方式与非 Docker 安装没有区别，但保存修改时需要以管理员权限运行 nano 或代码编辑器。

注意

别忘了重启 SillyTavern 的 Docker 容器以应用更改！请确保在 docker 文件夹内执行此命令。

docker compose restart sillytavern

查找用户数据

SillyTavern 的数据目录位于 data 文件夹中。备份文件很容易，但恢复或添加内容时可能需要管理员权限。

运行服务端插件

在 Docker 中运行 HoYoWiki-Scraper-TS 或 SillyTavern-Fandom-Scraper 等插件，与不使用 Docker 时没有区别，但需要对 Docker Compose 脚本做一点小修改。

提示

如果在 docker 文件夹内已看到 plugins 文件夹，可跳过步骤 1-2。

使用 nano 或代码编辑器打开 docker-compose.yml，在 volumes 下添加如下内容。

    volumes:
        - "./config:/home/node/app/config"
        - "./data:/home/node/app/data"
        - "./plugins:/home/node/app/plugins"

在 docker 文件夹中创建一个名为 plugins 的新文件夹。
按插件的说明进行安装。
使用 nano 或具备管理员权限的代码编辑器打开 config 文件夹内的 config.yaml，并启用 enableServerPlugins
```
enableServerPlugins: true
```
重启 Docker 容器。
```
docker compose restart sillytavern
```
完成。

安装

Linux

Windows

macOS

配置 SillyTavern

查找用户数据

运行服务端插件

来源、许可与维护