在服务器或 NAS 上安装

由于安全性限制，有部分应用设置通过配置文件提供。所以您的安装需要经历以下步骤：

1. 安装
2. 编辑配置文件

安装

您可以通过以下方式安装 Balsa：

1. 通过 Docker 安装，推荐目标设备提供了 Docker 图形界面的用户采用，例如各大 NAS 厂商。
2. 通过 Docker Compose 安装，推荐能够使用命令行且有较强 Linux 基础的用户采用。
3. 通过二进制安装，仅限高级用户。

TIP

在服务器或 NAS 上安装 Balsa 有一定上手难度，您可能需要具备一些 Linux 的基础知识。如果在安装中遇到困难，欢迎联系我们寻求帮助。

通过 Docker 安装

您需要通过您的 NAS 的控制台中的 Docker 管理器（部分 NAS 厂商称为 Container Station 或 Container Manager）创建容器。

您需要在容器创建表单中填入以下信息：

• 镜像 (别称：Image)： 您可以选填以下任意一种类型
  • docker.balsadl.com/balsa-webui:gnu 基于 gnu 的镜像，有更好的性能。
  • docker.balsadl.com/balsa-webui:musl 基于 musl 的镜像，有更低的存储和内存占用。
• 网络模式 (别称：Network Mode): 您可能需要进入高级选项
  • 主机 (Host)
• 存储映射 (别称：卷、存储、Volume、Mount): 您需要添加至少一个用于存储应用数据的卷
  • 从主机装载 (Mount)，选择一个您希望的用于存储用户数据的目录，装载到容器内的 /data。
  • ... 您可以从主机装载更多的自定义下载目录到容器内的任意路径，要指定这些路径作为下载目录，请参见编辑配置文件。

填写完成后点按创建即可完成安装，安装完成后您可以通过 http://您的-NAS-地址:7380 访问 Balsa，后续也可以编辑配置文件自定义一些选项。

TIP

您可以通过拉取(别称：Pull、提取)最新镜像并重新创建容器来更新 Balsa 版本。

注: 部分 NAS 控制台会提供直接重新创建选项。

通过 Docker Compose 安装

编辑以下 docker-compose.yaml 文件。

services:
  balsa:
    image: docker.balsadl.com/balsa-webui:gnu # 也可以使用 docker.balsadl.com/balsa-webui:musl
    # user: "1000:1000" # 您可以通过此条目控制 Balsa 使用的 uid:gid 以避免下载文件的权限问题。
    network_mode: host
    volumes:
      - <path-to-user-data>:/data # 这里填入您希望的 *用户数据* 的目录，这个目录用于存储 Balsa 的用户数据及下载内容，例如 /share/Balsa:/data。
      # 如果您还有其他更多的下载目录，请继续填写。如果您增加了更多的下载目录，请参考下述 *编辑配置文件*，为 Balsa 添加下载这些条目。

TIP

我们强烈建议您使用 network_mode: host 主机网络模式以支持以下特性：

1. Wake-on-LAN 网络唤醒
2. 更好的 IPv6 支持

如果您更希望使用默认的网络模式，您可能需要配置端口映射以访问 WebUI，默认的 WebUI 端口为 7380（可以通过配置文件修改）。

将以上 docker-compose.yaml 上传至您的服务器或 NAS，在命令行切换到该文件所在目录，执行以下命令：

docker compose up -d

TIP

您可以通过 docker compose logs 检查 Balsa 输出信息。

若包含输出 ... serving server listen_addr=0.0.0.0:7380 则安装正确。

安装完成后您可以通过 http://您的服务器地址:7380 访问 Balsa，后续也可以编辑配置文件自定义一些选项。

TIP

若您需要更新 Balsa，请切换到 docker-compose.yaml 文件所在目录并依次执行以下命令。

docker compose pull
docker compose up -d

通过二进制安装

您可以从我们的下载中心下载 Balsa WebUI 的二进制用于自定义部署。

# ./balsa-webui --help

Usage: balsa-webui [OPTIONS]

Options:
  -d, --data <DATA>      Custom data directory path, default: ${HOME}/.config/balsa
  -c, --config <CONFIG>  Custom config file path, default: ${DATA}/config.toml
      --show-licenses    Print 3rd-party open source licenses
  -h, --help             Print help

编辑配置文件

在安装并启动后，Balsa 会在您的选定的用户数据目录下生成初始配置文件。您编辑该文件后重启 Balsa 即可生效。

[server]
listen = "0.0.0.0:7380" # Balsa 服务监听地址，您可以通过此选项更改监听端口
# tls.cert = "./tls/cert.pem" # TLS 证书路径，会相对于用户数据目录查找
# tls.key = "./tls/key.pem" # TLS 私钥路径，会相对于用户数据目录查找

[runtime]
# max-worker-threads = 8 # 最大允许的工作线程数量。该选项与最大下载连接数无关，仅与最大 cpu 和内存用量相关。

# 以下是下载内容的存储路径，默认提供的下载路径是 用户数据目录/downloads。
# 您可以在此自定义更多的下载路径。注意：这里需要与安装时配置的存储(volumn/卷/装载)对应。
# key = "" 字段内容必须唯一。
[[storage]]
key = "default"
name = "Default"
path = "./downloads"

# [[storage]]
# key = "secondary"
# name = "次要存储"
# path = "/mnt/secondary"