x11vnc/docker-desktop

带有X11和VNC的Ubuntu Docker/Singularity镜像

本仓库提供了一个带有X11和VNC的Ubuntu Docker/Singularity镜像。它可用于提供统一环境，适用于教学编程课程、演示图形用户界面、开发调试软件程序以及在高性能计算（HPC）平台上可视化模拟结果。该镜像与https://github.com/fcwu/docker-ubuntu-vnc-desktop%E6%9C%89%E4%B8%80%E5%AE%9A%E7%9B%B8%E4%BC%BC%E6%80%A7%EF%BC%8C%E4%BD%86%E5%9C%A8%E5%AE%89%E5%85%A8%E6%80%A7%E5%92%8C%E5%8A%9F%E8%83%BD%E4%B8%8A%E6%9C%89%E5%A4%9A%E9%A1%B9%E5%A2%9E%E5%BC%BA%EF%BC%8C%E7%89%B9%E5%88%AB%E9%92%88%E5%AF%B9%E8%BD%AF%E4%BB%B6%E5%BC%80%E5%8F%91%E4%BA%BA%E5%91%98%E5%92%8CHPC%E7%94%A8%E6%88%B7%EF%BC%9A

• VNC通过每个会话的唯一随机密码或用户设置的复用密码进行保护
• 桌面以标准用户账户而非root账户运行
• 支持桌面动态调整大小和24位真彩色
• 支持Ubuntu LTS版本22.04、20.04和18.04，启动速度极快
• 支持简体中文（在x11vnc_desktop.py命令行选项中添加-t zh_CN）
• 自动将主机当前工作目录共享到Docker镜像
• 与Singularity兼容（已通过Singularity v3.5测试），适用于高性能计算平台

!https://github.com/x11vnc/x11vnc-desktop/actions/workflows/docker-image.yml/badge.svg

使用Docker前的准备工作

开始前，需先按照以下步骤在计算机上安装Python和Docker。

安装Python

若使用Linux或Mac，Python可能已预装，可跳过此步骤。

若使用Windows，需安装Python（如未安装）。最简单的方法是安装Miniconda，可从[***]

安装Docker

从[***] Community Edition并运行安装程序。注意，安装Docker需要管理员权限。安装完成后，确保在继续下一步前启动Docker。

Windows用户注意事项

1. Docker仅支持64位Windows 10 Pro或更高版本。若使用Windows 8或Windows 10 Home，需先升级操作系统。旧版Docker Toolbox支持旧版Windows，但不建议使用。
2. 安装Docker后，可能需要重启计算机以启用虚拟化。
3. 首次使用Docker时，必须更改设置以共享C盘。右键点击系统托盘中的Docker图标，选择“设置...”，进入“共享驱动器”选项卡并勾选C盘。

Linux用户注意事项

• 安装Docker后，确保通过以下命令将自己添加到Docker组：

sudo adduser $USER docker

然后注销并重新登录方可使用Docker。

运行Docker镜像

要运行Docker镜像，首先下载脚本https://raw.githubusercontent.com/x11vnc/x11vnc-desktop/master/x11vnc_desktop.py%E5%B9%B6%E4%BF%9D%E5%AD%98%E5%88%B0%E5%AD%98%E5%82%A8%E4%BB%A3%E7%A0%81%E5%92%8C%E6%95%B0%E6%8D%AE%E7%9A%84%E5%B7%A5%E4%BD%9C%E7%9B%AE%E5%BD%95%E3%80%82%E5%8F%AF%E9%80%9A%E8%BF%87%E5%91%BD%E4%BB%A4%E8%A1%8C%E4%B8%8B%E8%BD%BD%E8%84%9A%E6%9C%AC%EF%BC%9A%E5%9C%A8Windows%E4%B8%8A%EF%BC%8C%E5%90%AF%E5%8A%A8%E2%80%9CWindows PowerShell”，使用cd命令切换到存储代码和数据的工作目录，然后运行以下命令：

curl https://raw.githubusercontent.com/x11vnc/x11vnc-desktop/master/x11vnc_desktop.py -outfile x11vnc_desktop.py

在Linux或Mac上，启动终端，使用cd命令切换到工作目录，然后运行以下命令：

curl -s -O https://raw.githubusercontent.com/x11vnc/x11vnc-desktop/master/x11vnc_desktop.py

下载脚本后，可使用以下命令启动Docker镜像：

python x11vnc_desktop.py -p

这将下载并运行Docker镜像，然后启动默认Web浏览器显示桌面环境。-p选项为可选，用于指示Python脚本拉取并更新镜像至最新版本。默认情况下，工作目录会映射到主机上的当前工作目录。

要使用中文本地化，使用以下命令：

python x11vnc_desktop.py -t zh_CN

如需其他命令行选项，使用以下命令：

python x11vnc_desktop.py -h

构建自己的镜像

要构建自己的镜像，运行以下命令：

git clone https://github.com/x11vnc/x11vnc-desktop.git
docker build --rm -t x11vnc/docker-desktop x11vnc-desktop

然后使用x11vnc_desktop.py命令。

与Singularity一起使用

此Docker镜像构建为与Singularity兼容，已通过Singularity v3.5测试。若系统尚未安装Singularity，可按照这些说明安装。安装Singularity需要root权限，但安装后普通用户即可使用。若没有root权限（如在HPC平台上），请联系系统管理员安装。建议使用Singularity v2.6或更高版本。

要将Docker镜像与Singularity一起使用，执行以下命令：

singularity run -c -B $HOME docker://x11vnc/docker-desktop:latest

它会在Singularity中自动挂载一些最小化的/dev目录和$HOME，但不会挂载大多数其他目录（如/run、/tmp等）。若不想挂载主目录，可移除-B $HOME选项。

或者，若使用Singularity v3.x，可使用以下命令：

singularity pull x11vnc-desktop:latest.sif docker://x11vnc/docker-desktop:latest
singularity run -c -B $HOME ./x11vnc-desktop:latest.sif

关于Singularity的注意事项：

• 使用Singularity时，容器中的用户名与主机上的用户名相同。仍可读取/home/$DOCKER_USER目录。
• 为避免与主机上的用户配置冲突，此镜像在容器中使用/bin/zsh作为登录shell。默认情况下，若/home/$DOCKER_USER/.zprofile和/home/$DOCKER_USER/.zshrc不存在，会复制到主目录。若主机使用其他登录shell（如/bin/bash），效果最佳。若您是zsh用户，可能需要编辑.zshrc和.zprofile以同时在主机和Singularity镜像中工作。
• 为避免与X11配置潜在冲突，此镜像使用LXDE作为桌面管理器。若主机不使用LXDE，效果最佳。

Forks和Pull Requests

欢迎Fork项目并根据自身需求自定义。本仓库使用Github Actions自动构建Docker镜像并推送到Docker Hub。为确保Fork中的Github Actions正常工作，请执行以下三个步骤：

1. 若尚无https://hub.docker.com/%E8%B4%A6%E6%88%B7%EF%BC%8C%E8%AF%B7%E5%88%9B%E5%BB%BA%E4%B8%80%E4%B8%AA%E3%80%82%E5%B0%86Github%E4%BB%93%E5%BA%93%E5%AF%86%E9%92%A5%60DOCKER_HUB_USERNAME%60%E8%AE%BE%E7%BD%AE%E4%B8%BADocker%E7%94%A8%E6%88%B7%E5%90%8D%E3%80%82
2. 将Github仓库密钥DOCKER_HUB_USERNAME和DOCKER_HUB_ACCESS_TOKEN设置为Docker Hub用户名和密码。有关获取Docker Hub访问令牌的详细说明，请参见[***]
3. 在https://hub.docker.com/%E8%B4%A6%E6%88%B7%E4%B8%AD%E5%88%9B%E5%BB%BA%60docker-desktop%60%E4%BB%93%E5%BA%93%EF%BC%8C%E4%BB%A5%E4%BE%BF%E6%9E%84%E5%BB%BA%E7%9A%84%E9%95%9C%E5%83%8F%E5%8F%AF%E6%8E%A8%E9%80%81%E5%88%B0%E6%82%A8%E7%9A%84Docker Hub账户。

也欢迎Pull Requests。请确保您的更改已通过Pull Request的GitHub Actions CI。

开发者

x11vnc-desktop项目由Xiangmin Jiao开发，作为Stony Brook University教学和研究的工具。请注意，此项目独立于https://github.com/LibVNC/x11vnc%E9%A1%B9%E7%9B%AE%E3%80%82

许可证

详情参见LICENSE文件。

相关项目

• https://github.com/LibVNC/x11vnc%EF%BC%9A%E7%94%B1Karl Runge最初开发，现由LibVNC和GitHub社区维护的真实X显示VNC服务器。
• https://github.com/novnc/noVNC%EF%BC%9A%E4%BD%BF%E7%94%A8HTML5%EF%BC%88Web Sockets、Canvas）的VNC客户端。
• https://github.com/fcwu/docker-ubuntu-vnc-desktop%EF%BC%9AUbuntu%E6%A1%8C%E9%9D%A2%E7%9A%84%E5%8E%9F%E5%A7%8B%E4%BD%86%E4%B8%8D%E5%AE%89%E5%85%A8%E5%AE%9E%E7%8E%B0%EF%BC%8C%E6%97%A0%E5%AF%86%E7%A0%81%E4%BF%9D%E6%8A%A4%E3%80%82
• https://github.com/phusion/baseimage-docker%EF%BC%9A%E4%B8%BADocker%E5%8F%8B%E5%A5%BD%E6%80%A7%E4%BF%AE%E6%94%B9%E7%9A%84%E6%9C%80%E5%B0%8FUbuntu%E5%9F%BA%E7%A1%80%E9%95%9C%E5%83%8F%E3%80%82