ssh-docker

一个 Sumor Cloud 工具。
更多文档

ssh-docker 是用于 @sumor/ssh-tools 的 docker 工具

安装

npm i @sumor/ssh-docker --save

先决条件

Node.JS 版本

要求 Node.JS 版本为 18.x 或更高

需要 Node.JS ES 模块

由于此软件包是使用 ES 模块编写的，请在您的 package.json 文件中更改以下代码：

{
  "type": "module"
}

使用

导入工具

import SSHBasic from '@sumor/ssh-tools'
import docker from '@sumor/ssh-docker'

class SSH extends SSHBasic {
  constructor(config) {
    super(config)
    this.addTool('docker', docker)
  }
}

export default SSH

使用工具

import SSH from './ssh.js'

const ssh = new SSH(server)

await ssh.connect()

// 构建 Docker 镜像
const sourceFolder = '/path/to/source/folder'
const imageName = 'image-name'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, imageName, version)

// 镜像列表
const images = await ssh.docker.images()

// 是否存在镜像
const exists = await ssh.docker.existsImage(imageName, version)

// 运行 Docker 容器
await ssh.docker.run({
  name: 'container-name',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // 容器端口
      to: 30123 // 主机端口
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // 容器文件夹
      to: '/path/to/config/folder', // 主机文件夹
      readOnly: true // 可选, 默认为 false
    }
  ]
})

// 容器列表
const containers = await ssh.docker.containers()

// 是否存在容器
const exists = await ssh.docker.exists('container-name')

// 在容器中执行命令
const result = await ssh.docker.exec('container-name', 'ls -al')

// 删除容器
await ssh.docker.remove('container-name')

// 删除镜像
await ssh.docker.removeImage(imageName, version)

// 构建 Node.js 项目
const logs = await ssh.docker.buildNode('/path/to/source')

// 运行 Node.js 项目
const logs = await ssh.docker.runNode('container-name', '/path/to/source', {
  port
})

// 运行 Nginx
const logs = await ssh.docker.runNginx({
  name: 'container-name',
  ports: [
    {
      from: 443, // 容器端口
      to: 30123 // 主机端口
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // 容器文件夹
      to: '/path/to/config/folder', // 主机文件夹
      readOnly: true // 可选, 默认为 false
    }
  ]
})

// 更新 Nginx 配置
await ssh.docker.updateNginx(dockerId)

// 运行站点
await ssh.docker.runSite({
  workerProcesses: 2,
  workerConnections: 2048,
  port: 30100,
  domains: [
    {
      domain: 'dev.example.com',
      servers: [
        {
          host: 'dev.example.com',
          port: 30001,
          maxFails: 3,
          maxConns: 5
        },
        {
          host: 'dev.example.com',
          port: 30002,
          weight: 1
        }
      ]
    }
  ]
})

await ssh.disconnect()