rstudio/rstudio-connect

Posit Connect Docker 镜像文档

镜像概述和主要用途

Posit Connect 是一个企业级内容发布平台，允许用户轻松部署和共享数据科学内容。该 Docker 镜像提供了 Posit Connect 的预配置环境，简化了在容器化环境中部署和管理 Posit Connect 的过程。

主要用途包括：

• 集中部署和管理 Shiny 应用、R Markdown 文档、Plumber API、Python Jupyter 笔记本等多种内容类型
• 提供安全的访问控制和内容共享机制
• 支持自动化内容更新和调度
• 简化企业内部数据科学成果的发布和协作流程

核心功能和特性

• 一键部署：支持 Shiny 应用、R Markdown 文档、Plumber API、Python Jupyter 笔记本、Quarto 文档和项目，或任何静态 R 图表的"一键"部署
• 扩展部署能力：支持 Python API 和应用（包括 Shiny for Python、Flask、Dash、FastAPI、Bokeh 和 Streamlit），以及通过 Git 或命令行脚本实现的任何内容类型的自动部署
• 访问管理：能够管理和限制对共享内容的访问权限，并轻松查看他人共享的内容
• 自动更新：支持文档更新的"免提"调度和自动电子邮件分发
• 多语言支持：内置对 R 和 Python 的支持，包括多种版本

快速参考

• 维护者：https://github.com/rstudio/rstudio-docker-products
• 获取帮助：https://github.com/rstudio/rstudio-docker-products/issues%E3%80%81Posit Connect 文档、Posit 社区论坛 或 Posit 支持
• Posit Connect 镜像：https://hub.docker.com/r/rstudio/rstudio-connect%E3%80%81https://github.com/rstudio/rstudio-docker-products/pkgs/container/rstudio-connect
• Posit Connect Content Init 镜像：https://hub.docker.com/r/rstudio/rstudio-connect-content-init%E3%80%81https://github.com/rstudio/rstudio-docker-products/pkgs/container/rstudio-connect-content-init

支持的标签和对应的 Dockerfile 链接

• https://github.com/rstudio/rstudio-docker-products/blob/main/connect/Dockerfile.2204

支持注意事项

1. 此镜像可能引入破坏性变更，因此我们建议：

   • 避免使用 {operating-system} 标签以避免意外的版本升级
   • 更新前务必阅读 NEWS 以了解变更内容

2. 过时的镜像将随着产品版本更新定期从 DockerHub 中移除。请计划定期更新或使用自己构建的镜像。

3. 这些镜像旨在作为满足您需求的起点。考虑创建此仓库的分支，您可以继续合并我们所做的更改，同时拥有自己的安全扫描、基础操作系统或其他自定义更改。我们提供了https://github.com/rstudio/rstudio-docker-products#instructions-for-building%E7%94%A8%E4%BA%8E%E8%BF%99%E4%BA%9B%E6%83%85%E5%86%B5%E3%80%82

4. 安全注意：这些镜像基于产品版本发布/更新时的构建环境按"原样"提供。在生产使用前应进行审查和更新。如果您的组织对安全有特定要求，请计划使用https://github.com/rstudio/rstudio-docker-products#instructions-for-building%E5%85%8B%E9%9A%86%E6%AD%A4%E4%BB%93%E5%BA%93%EF%BC%8C%E5%B9%B6%E6%A0%B9%E6%8D%AE%E6%82%A8%E7%9A%84%E7%89%B9%E5%AE%9A%E5%86%85%E9%83%A8%E5%AE%89%E5%85%A8%E6%A0%87%E5%87%86%E9%87%8D%E5%BB%BA%E8%BF%99%E4%BA%9B%E9%95%9C%E5%83%8F%E3%80%82

使用场景和适用范围

Posit Connect 适用于以下场景：

• 企业内部数据科学团队协作和成果共享
• 安全地向组织内部利益相关者发布交互式应用和报告
• 自动化报告生成和分发流程
• 集中管理和监控数据科学内容
• 为不同部门或项目提供隔离的内容发布环境

适用范围包括：

• 中大型企业数据科学团队
• 学术研究机构
• 需要安全共享数据分析成果的组织
• 希望标准化和简化内容部署流程的团队

详细的使用方法和配置说明

概述

此 Docker 容器是按照 Posit Connect 管理指南 构建的，有关要求和如何扩展此镜像的更多详细信息，请参阅 服务器指南/Docker。

该容器包含：

1. 两个版本的 R
2. 两个版本的 Python
3. Quarto
4. Posit Professional Drivers
5. Posit Connect

注意，运行 Posit Connect Docker 镜像需要容器使用 --privileged 标志运行，并需要有效的 Posit Connect 许可证。

重要：要使 Posit Connect 支持多个用户，您需要在 rstudio-connect.gcfg 文件中定义 Server.Address。为此，请使用用户访问 Connect 时将使用的 URL 更新您的配置文件，然后启动或重新启动容器。

基本使用示例

以下是使用产品许可证密钥在 Docker 中本地运行 Connect 的简单示例：

bash
# 替换为有效的许可证
export RSC_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

# 无持久数据并使用默认配置运行
docker run -it --privileged \
    -p 3939:3939 \
    -e RSC_LICENSE=$RSC_LICENSE \
    rstudio/rstudio-connect:ubuntu2204

运行后，打开 http://localhost:3939 访问 Posit Connect。

配置

Posit Connect 的配置在 /etc/rstudio-connect/rstudio-connect.gcfg 文件中进行，将此文件作为卷挂载到主机上的外部文件，以更改配置并重新启动容器使更改生效。

确保配置文件包含以下字段：

• Server.Address 设置为用户访问 Connect 的确切 URL。默认使用占位符 http://localhost:3939
• Server.DataDir 设置为 /data/
• HTTP.Listen（或等效的 HTTP、HTTPS 或 HTTPRedirect 设置。这可能会改变您配置容器端口的方式）
• Python.Enabled 和 Python.Executable

有关该文件的完整示例，请参见 connect/rstudio-connect.gcfg。

持久化数据

为了在容器重启之间持久化 Connect 元数据和应用数据，请将 Connect 的 Server.DataDir 选项配置为指向持久卷。

包含的配置文件期望来自主机机器或 Docker 编排系统的持久卷在 /data 处可用。如果您希望将其移动到不同的路径，可以更改 Server.DataDir 选项。

以下是将 Posit Connect 容器与附加到 /data 目录的绑定挂载一起运行的示例：

bash
docker run -it --privileged \
    -p 3939:3939 \
    -e RSC_LICENSE=$RSC_LICENSE \
    --mount type=bind,src=/path/to/local/directory,dst=/data \
    rstudio/rstudio-connect:ubuntu2204

产品许可

使用 Posit Connect docker 镜像需要有效的许可证。您可以通过三种不同方式设置许可证：

1. 将 RSC_LICENSE 环境变量设置为容器内的有效许可证密钥
2. 将 RSC_LICENSE_SERVER 环境变量设置为容器内的有效许可证服务器/端口
3. 挂载 /var/lib/rstudio-connect/*.lic 单个文件，其中包含 Posit Connect 的有效许可证

注意：离线安装需要使用浮动许可证服务器、许可证文件或手动干预的自定义镜像才能成功激活实例。

使用许可证文件的示例

容器将自动在 /var/lib/rstudio-connect/*.lic 中查找许可证文件，如果存在，将尝试使用它进行激活。此示例使用绑定挂载从主机提供许可证文件。

bash
docker run -it --privileged \
    -p 3939:3939 \
    --mount type=bind,ro,src=<path to license file>,dst=/var/lib/rstudio-connect/rstudio-connect.lic \
    rstudio/rstudio-connect:ubuntu2204

或者，可以使用 RSC_LICENSE_FILE_PATH 环境变量提供容器中许可证文件的路径。如果提供，容器将尝试从给定路径的文件中查找并激活。

bash
docker run -it --privileged \
    -p 3939:3939 \
    -e RSC_LICENSE_FILE_PATH=/opt/license.lic \
    --mount type=bind,ro,src=<path to license file>,dst=/opt/license.lic \
    rstudio/rstudio-connect:ubuntu2204

如果许可证文件未能成功激活，容器在大多数情况下将无法启动。您仍然可以通过对 license-manager 二进制文件运行 status 命令来验证容器的许可状态。

bash
$ docker exec -it <container name> /opt/rstudio-connect/bin/license-manager status
TTY detected. Printing informational message about logging configuration. Logging configuration loaded from '/etc/rstudio/logging.conf'. Logging to '/var/log/rstudio/rstudio-server/license-manager.log'.
RStudio License Manager 2025.09.1+764.pro1

-- License file status --

Status: Activated
Product-Key: XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
Has-Key: Yes
Has-Trial: No
Tier: Tier Name
SKU-Year: 2024
Enable-Launcher: 1
Users: 0
User-Activity-Days: 365
Shiny-Users: 0
Allow-APIs: 1
Anonymous-Servers: 0
Unrestricted-Servers: 0
Licensee: Company Name
License-File: /var/lib/rstudio-connect/rstudio-connect.lic
Expiration: YYYY-MM-DD HH:mm:ss
Days-Left: XXX
License-Engine: 1.0.0.0
License-Scope: System

-- Local license status --

Trial-Type: Verified
Status: Expired
Has-Key: No
Has-Trial: Yes
License-Scope: System
License-Engine: 4.4.3.0

-- Floating license status --

License server not in use.

使用许可证密钥的示例

也可以通过设置 RSC_LICENSE 环境变量使用许可证密钥激活容器。

bash
# 替换为有效的许可证
export RSC_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX

# 无持久数据并使用外部配置运行
docker run -it --privileged \
    -p 3939:3939 \
    -e RSC_LICENSE=$RSC_LICENSE \
    rstudio/rstudio-connect:ubuntu2204

如果可能，生产环境中应避免使用许可证密钥激活，而应使用许可证文件，因为当容器未正常停止时，存在许可证激活泄露的风险。有关许可证密钥问题的更多详细信息，请参阅下面的容器中产品许可的注意事项部分。

Docker Compose 配置示例

以下是使用 Docker Compose 部署 Posit Connect 的示例配置：

yaml
version: '3.8'

services:
  rstudio-connect:
    image: rstudio/rstudio-connect:ubuntu2204
    container_name: rstudio-connect
    privileged: true
    ports:
      - "3939:3939"
    environment:
      - RSC_LICENSE=XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX
    volumes:
      - ./data:/data
      - ./config/rstudio-connect.gcfg:/etc/rstudio-connect/rstudio-connect.gcfg
    restart: unless-stopped
    stop_grace_period: 2m

环境变量

端口

容器中产品许可的注意事项

注意：本节不适用于使用许可证文件的激活。

在容器中使用我们的产品时，目前存在一个已知的许可错误。如果容器未正常停止，许可证停用步骤可能会失败或被跳过。未能停用许可证可能导致"许可证泄露"，即产品激活被耗尽，并且由于容器上的激活状态已丢失，无法使用传统方法停用。

为避免"泄露"许可证，我们建议用户不要强制终止容器，并对 docker run 和 docker stop 命令分别使用 --stop-timeout 120 和 --time 120。这有助于确保停用脚本有足够的时间正常运行。

在某些情况下，可能难以或无法避免硬终止（例如，电源故障、主机上的严重错误）。不幸的是，这些情况中的任何一种都可能导致许可证泄露激活。为了帮助防止这些情况下的许可证泄露，用户可以将以下目录挂载到持久存储，以保留许可证状态数据供容器重启时使用。这些目录因产品而异。

• 许可证密钥
  • /var/lib/.local
  • /var/lib/.prof
  • /var/lib/rstudio-connect
• 浮动许可证
  • /var/lib/.TurboFloat

请注意，在这些目录中创建的文件是硬件锁定的，不能在主机之间传输。由于硬件指纹算法的特性，对主机或容器的任何低级更改都可能导致现有许可证状态文件失效。为避免此问题，我们建议在更改主机上的任何硬件或固件（例如，升级网卡或更新 BIOS）或容器（例如，更改使用的网络驱动程序或分配的 CPU 核心数）之前，正常关闭产品容器并允许其停用。

虽然保留许可证状态数据可以帮助避免重启时的许可证泄露，但这并不能保证。如果您在许可证方面遇到问题，请随时联系 Posit 支持。

虽然这些解决方案都不能完全消除问题，但它们应该有助于缓解问题。我们仍在研究长期解决方案。

许可

与 Posit Docker Products 仓库相关的许可位于https://github.com/rstudio/rstudio-docker-products/blob/main/LICENSE.md%E4%B8%AD%E3%80%82

与所有容器镜像一样，镜像本身还包含可能受其他许可约束的其他软件（即 bash、linux、系统库等，以及包含的主要软件的任何其他直接或间接依赖项）。

镜像用户有责任确保使用此镜像（及其任何依赖层）符合镜像中包含的软件的所有相关许可。