如何使用 MongoDB Compass 连接到 Github 代码空间中的 MongoDB、运行?

How do I connect to MongoDB, running in Github codespaces, using MongoDB Compass?

我正在尝试 Github 代码空间,特别是“Node.js & Mongo DB”默认设置。

端口被转发,我的objective是连接我本地机器上的MongoDB Compass 运行。

转发给27017的地址类似于https://<long-address>.githubpreview.dev/

我的尝试

我尝试使用以下连接字符串,但它在 MongoDB 罗盘中不起作用。它因 No addresses found at host 而失败。我实际上不确定如何确定 MongoDB 在 Github 代码空间中是否实际上是 运行?

mongodb+srv://root:example@<long-address>.githubpreview.dev/

.devcontainer 文件


docker-compose.yml

version: '3.8'

services:
  app:
    build:
      context: .
      dockerfile: Dockerfile
      args:
        # Update 'VARIANT' to pick an LTS version of Node.js: 16, 14, 12.
        # Append -bullseye or -buster to pin to an OS version.
        # Use -bullseye variants on local arm64/Apple Silicon.
        VARIANT: "16"
    volumes:
      - ..:/workspace:cached
    init: true

    # Overrides default command so things don't shut down after the process ends.
    command: sleep infinity

    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
    network_mode: service:db
    # Uncomment the next line to use a non-root user for all processes.
    # user: node

    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally. 
    # (Adding the "ports" property to this file will not forward from a Codespace.)

  db:
    image: mongo:latest
    restart: unless-stopped
    volumes:
      - mongodb-data:/data/db
    # Uncomment to change startup options
    environment:
     MONGO_INITDB_ROOT_USERNAME: root
     MONGO_INITDB_ROOT_PASSWORD: example
     MONGO_INITDB_DATABASE: foo

    # Add "forwardPorts": ["27017"] to **devcontainer.json** to forward MongoDB locally.
    # (Adding the "ports" property to this file will not forward from a Codespace.)

volumes:
  mongodb-data: null

还有一个devcontainer.json文件

// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.203.0/containers/javascript-node-mongo
// Update the VARIANT arg in docker-compose.yml to pick a Node.js version
{
    "name": "Node.js & Mongo DB",
    "dockerComposeFile": "docker-compose.yml",
    "service": "app",
    "workspaceFolder": "/workspace",

    // Set *default* container specific settings.json values on container create.
    "settings": {},

    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
        "dbaeumer.vscode-eslint",
        "mongodb.mongodb-vscode" 
    ],

    // Use 'forwardPorts' to make a list of ports inside the container available locally.
    "forwardPorts": [3000, 27017],

    // Use 'postCreateCommand' to run commands after the container is created.
    // "postCreateCommand": "yarn install",

    // Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
    "remoteUser": "node",
    "features": {
        "git": "os-provided"
    }
}

最后是 Docker 文件:

# [Choice] Node.js version (use -bullseye variants on local arm64/Apple Silicon): 16, 14, 12, 16-bullseye, 14-bullseye, 12-bullseye, 16-buster, 14-buster, 12-buster
ARG VARIANT=16-bullseye
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}

# Install MongoDB command line tools if on buster and x86_64 (arm64 not supported)
ARG MONGO_TOOLS_VERSION=5.0
RUN . /etc/os-release \
    && if [ "${VERSION_CODENAME}" = "buster" ] && [ "$(dpkg --print-architecture)" = "amd64" ]; then \
        curl -sSL "https://www.mongodb.org/static/pgp/server-${MONGO_TOOLS_VERSION}.asc" | gpg --dearmor > /usr/share/keyrings/mongodb-archive-keyring.gpg \
        && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/mongodb-archive-keyring.gpg] http://repo.mongodb.org/apt/debian $(lsb_release -cs)/mongodb-org/${MONGO_TOOLS_VERSION} main" | tee /etc/apt/sources.list.d/mongodb-org-${MONGO_TOOLS_VERSION}.list \
        && apt-get update && export DEBIAN_FRONTEND=noninteractive \
        && apt-get install -y mongodb-database-tools mongodb-mongosh \
        && apt-get clean -y && rm -rf /var/lib/apt/lists/*; \
    fi

# [Optional] Uncomment this section to install additional OS packages.
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
#     && apt-get -y install --no-install-recommends <your-package-list-here>

# [Optional] Uncomment if you want to install an additional version of node using nvm
# ARG EXTRA_NODE_VERSION=10
# RUN su node -c "source /usr/local/share/nvm/nvm.sh && nvm install ${EXTRA_NODE_VERSION}"

# [Optional] Uncomment if you want to install more global node modules
# RUN su node -c "npm install -g <your-package-list-here>"

更新 我还在 MongoDB 社区发布了 here,但没有帮助...

正如@iravinandan 所说,您需要建立一个隧道。

单独发布端口无济于事,因为所有传入请求都通过 HTTP 代理。

如果您 dig CNAME <long-address>.githubpreview.dev,您会看到它是 github-codespaces。app.online.visualstudio.com。您可以在 githubpreview.dev 子域中放置任何内容,它仍将在 DNS 级别进行解析。

代理依靠 HTTP 主机 header 将请求路由到正确的上游,因此它仅适用于 HTTP 协议。

要使用任何其他协议(MongoDb wire protocol 在你的情况下)你需要设置一个 TCP 隧道 代码spaces 到你的机器。

最简单的设置 - 直接连接

在编写默认 Node + Mongo 代码时space 使用 Debian buster,因此 ssh port forwarding 将是显而易见的选择。在 codespace/VSCode 终端中:

ssh -R 27017:localhost:27017 your_public_ip

然后在你的指南针中连接到

mongodb://localhost:27017

它需要你的本地机器 运行 sshd 当然,有一个白色 IP(或者至少你的路由器应该转发 incoming ssh 流量到你的计算机)并在防火墙中允许它。如果 27017 已在本地使用,您可以选择任何端口。

这是最简单的设置,但它会将您的笔记本电脑暴露在互联网上,感染它只是时间问题。

更安全一点 - 中间的跳转箱

为了让您的本地系统保持在 DMZ 后面,您可以设置一个跳转箱 - 互联网上某处的一个简约的一次性 linux 盒子,它将用于链接 2 个隧道:

  • 从代码space到jumpbox
  • 的远程端口转发
  • 从您的笔记本电脑到 jumpbox 的本地端口转发

一样

mongodb://localhost:27017

在 mongo compas.

jumpbox 必须将 sshd 暴露给互联网,但您可以通过加强其安全性来最大限度地降低风险。毕竟它除了代理流量什么都不做。 EC2 nano 绰绰有余,请记住大数据传输可能很昂贵。

Hassle-freetunnel-as-a-service

您可以在 5 分钟内尝试的内容。 ngrok 已经存在十多年了,它正是这样做的 - 它销售隧道(有一些免费层足以进行演示)。

在您的 codespace/VScode 终端中:

npm i ngrok --save-dev

为了避免每次都安装,但要确保您不附带生产代码。 您将需要在 ngrok 上注册一个帐户(使用 github 的 SSO 即可)以获取验证码并将其传递到 codespaces/VSCode 终端:

./node_modules/.bin/ngrok authtoken <the token>

请记住它会将令牌保存到主目录中,重建后将被擦除。一旦获得授权,您就可以在 codespaces/VSCode 终端中打开隧道:

./node_modules/.bin/ngrok tcp 27017

代码space会自动转发端口:

终端会显示一些统计数据(注意免费套餐限制)和连接字符串:

每次打开隧道时,子域和端口都会发生变化。 从上图中,mongodb compas 的连接参数将是:

mongodb://0.tcp.ngrok.io:18862

根据需要在 mongodb 级别使用授权参数。

再次提醒,请记住您将 mongodb 暴露在互联网上 (0.tcp.ngrok.io:18862),并且 mongo 接受未经身份验证的连接。

我不会让它打开超过必要的时间。

使用built-in mongodb客户端

node + mongo 环境带有方便的 VScode 插件 pre-installed:

当然,它缺少许多 compas 分析工具,但它开箱即用,足以 开发

只需打开插件并连接到本地主机:

罗盘D.I.Y

在不影响安全性的情况下获得指南针功能并实现 zero-config objective 的最佳选择是自己托管指南针。它是一个电子应用程序,在 Mongodb Atlas.

的浏览器中完美运行。

源代码位于 https://github.com/mongodb-js/compass。 通过一些努力,您可以制作一个 docker 图像来托管指南针,将此图像包含到 docker-compose 中,然后将端口转发到 devcontainer.json

Github codespaces 将负责身份验证(将转发端口保密,因此只有 space 的所有者才能访问它)。从桌面到 compass 的所有通信都将通过 https,而 compass 到 mongodb 将在 docker 网络本地。 Security-wise 它将与 VSCode mongodb 插件

相提并论