ssh-docker

أداة Sumor Cloud.
مزيد من التوثيق

ssh-docker هو أداة docker لـ @sumor/ssh-tools

التثبيت

npm i @sumor/ssh-docker --save

المتطلبات الأساسية

إصدار Node.JS

يتطلب إصدار Node.JS 18.x أو أحدث

يتطلب إصدار Node.JS ES module

نظرًا لأن هذه الحزمة مكتوبة بلغة ES module، يرجى تغيير الشكل التالي في ملف 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 build image
const sourceFolder = '/path/to/source/folder'
const imageName = 'image-name'
const version = '1.0.0'
await ssh.docker.buildImage(sourceFolder, imageName, version)

// images list
const images = await ssh.docker.images()

// exists image
const exists = await ssh.docker.existsImage(imageName, version)

// docker run container
await ssh.docker.run({
  name: 'container-name',
  image: imageName,
  version: version,
  ports: [
    {
      from: 443, // container port
      to: 30123 // host port
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // container folder
      to: '/path/to/config/folder', // host folder
      readOnly: true // اختياري, القيمة الافتراضية false
    }
  ]
})

// docker containers list
const containers = await ssh.docker.containers()

// exists container
const exists = await ssh.docker.exists('container-name')

// exec command in container
const result = await ssh.docker.exec('container-name', 'ls -al')

// docker delete container
await ssh.docker.remove('container-name')

// docker delete image
await ssh.docker.removeImage(imageName, version)

// build node.js project
const logs = await ssh.docker.buildNode('/path/to/source')

// run node.js project
const logs = await ssh.docker.runNode('container-name', '/path/to/source', {
  port
})

// run Nginx
const logs = await ssh.docker.runNginx({
  name: 'container-name',
  ports: [
    {
      from: 443, // container port
      to: 30123 // host port
    }
  ],
  bindings: [
    {
      from: '/usr/source/config', // container folder
      to: '/path/to/config/folder', // host folder
      readOnly: true // اختياري, القيمة الافتراضية false
    }
  ]
})

// update Nginx config
await ssh.docker.updateNginx(dockerId)

// run site
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()