arhea
arhea
harbor-master
JavaScript

🛥️ Harbor Master is a Docker Remote API client written in Node.js

Last updated Feb 6, 2026
78
Stars
18
Forks
12
Issues
0
Stars/day
Attention Score
21
View on GitHub ↗ Open in github.dev
Topics
#docker#docker-api#docker-sdk#harbor-master#nodejs#npm#npm-module#swarm
Language breakdown
JavaScript 100.0%
▸ Files click to expand
README

Harbor Master

Build Status

NPM NPM

Harbor Master is a Docker Remote API client written in Node. This client is meant to be a simple wrapper that makes it easy to communicate with your Docker Daemon over the unix socket or http based APIs.

This project is still in active development. This project will be versioned in accordance with the Docker Remote API. For example, if the current Docker Remote API version is 1.32, Harbor Master's version will be 1.32.x.

Table of Contents

+ Client + API + Configs + Containers + Images + Networks + Volumes + Secrets + Swarm + Nodes + Services + Tasks + Plugins + Systems

Examples

Unix Socket Example

const docker = require('../index');

const client = docker.Client({   socket: '/var/run/docker.sock' });


client.info().then((info) => {   console.log(info); }).catch((err) => {   console.error(err); });

Remote Host Example

const docker = require('../index');

const client = docker.Client({   host: 'swarm.example.com',   port: '2375' });


client.info().then((info) => {   console.log(info); }).catch((err) => {   console.error(err); });

SSL Configuration

const docker = require('../index');

const client = docker.Client({   host: 'swarm.example.com',   port: '2376',   tls: {     ca: fs.readFileSync('ca.pem'),     cert: fs.readFileSync('cert.pem'),     key: fs.readFileSync('key.pem'),     passphrase: 'supersecretpass'   } });


client.info().then((info) => {   console.log(info); }).catch((err) => {   console.error(err); });

API Documentation

docker.Client(options) - Harbor Master Client

  • options
+ host - the IP address or Hostname of the Docker server + port - the port number the Docker server exposes + socket - the unix socket + tls * cert - contents of the server certificate * key - contents of the server certificate key * ca - contents of the CA certificate * password - the certificate password

Configs

client.configs().list(options) - List Configs

+ filters - map[string][]string to process on the configs list

client.configs().create(model, options) - Create Config

client.configs().inspect(id, options) - Inspect Config

client.configs().remove(id, options) - Remove Config

client.configs().update(id, model, options) - Update Config

  • Docker Documentation
  • id - the id or name of the config
  • model - the JSON model that the Docker API consumes
  • options
+ version - The version number of the config object being updated. This is required to avoid conflicting writes.

Containers

client.containers().list(options) - List Containers

+ all - default: false Show all containers. Only running containers are shown by default. + limit - Show limit last created containers, include non-running ones. + since - Show only containers created since Id, include non-running ones. + before - Show only containers created before Id, include non-running ones. + size - default: false Show the containers sizes + filters - map[string][]string to process on the containers list

client.containers().create(model, options) - Create Container

+ name - Assign the specified name to the container. Must match /?[a-zA-Z0-9_-]+.

client.containers().inspect(name, options) - Inspect Container

+ size - default: false Show the containers sizes

client.containers().top(name) - List Processes Running Inside a Container

+ ps_args - ps arguments to use (e.g., aux), defaults to -ef

client.containers().logs(name, options) - Container Logs

+ details - Show extra details provided to logs. default: false + follow - return stream. default: false + stdout - show stdout log. default: false + stderr - show stderr log. default: false + since - Specifying a timestamp will only output log-entries since that timestamp. default: false + timestamps - print timestamps for every log line default: false + tail - Output specified number of lines at the end of logs: all or default: all

client.containers().changes(name, options) - Inspect Container Filesystem Changes

client.containers().export(name, options) - Export a Container

client.containers().stats(name, options) - Export a Container

+ stream - stream statistics default: true

client.containers().resize(name, options) - Resize a container TTY

+ h - height + w - width

client.containers().start(name, options) - Start a Container

+ detachKeys - Override the key sequence for detaching a container. Format is a single character.

client.containers().stop(name, options) - Stop a Container

+ t - number of seconds to wait before killing the container

client.containers().restart(name, options) - Restart a Container

+ t - number of seconds to wait before killing the container

client.containers().kill(name, options) - Kill a Container

+ signal - Signal to send to the container: integer or string like SIGINT. When not set, SIGKILL is assumed and the call waits for the container to exit.

client.containers().update(name, model, options) - Update a Container

  • Docker Documentation
  • name - the name or id of the container
  • model - the JSON model that the Docker API consumes
  • options

client.containers().rename(name, options) - Rename a Container

+ name - new name for the container

client.containers().pause(name) - Pause a Container

client.containers().unpause(name) - Unpause a Container

client.containers().attach(name, options) - Attach a Container

+ detachKeys - Override the key sequence for detaching a container. Format is a single character + logs - return logs default: false + stream - return stream default: false + stdin - return stdin default: false + stdout - return stdout default: false + stderr - return stderr default: false

client.containers().unpause(name, options) - Wait a Container

client.containers().remove(name, options) - Wait a Container

+ v - Remove the volumes associated to the container default: false + force - Kill then remove the container default: false

Images

client.images().list(options) - Wait a Container

+ filters - map[string][]string to process on the images list

client.images().build(stream, options, registryAuth) - Build an Image From a Dockerfile

+
  • registryAuth
+ username + password + serveraddress

client.images().create(options, registryAuth) - Create Image

+ fromImage + fromSrc + repo + q + tag
  • registryAuth
+ username + password + serveraddress

client.images().inspect(name, options) - Inspect an Image

client.images().history(name, options) - History of an Image

client.images().push(name, options, registryAuth) - Push an Image on the Registry

+ tag
  • registryAuth
+ username + password + serveraddress

client.images().tag(name, options) - Tag an Image

+ repo + tag

client.images().remove(name, options) - Remove of Image

+ repo + tag

client.images().search(options) - Search Images

+ term + limit + filters

Networks

client.networks().list(options) - List Networks

+ filters - JSON encoded network list filter.

client.networks().create(model, options) - Create a Network

client.networks().inspect(id, options) - Inspect a Network

client.networks().remove(id, options) - Remove a Network

client.networks().connect(id, options) - Connect a Container to a Network

client.networks().disconnect(id, options) - Disconnect a Container to a Network

Nodes

client.nodes().list(options) - List Nodes

+ filters - JSON encoded node list filter.

client.nodes().inspect(id, options) - Inspect a Node

client.nodes().remove(id, options) - Remove a Node

client.nodes().update(id, options) - Update A Node

+ version - The version number of the node object being updated. This is required to avoid conflicting writes.

Plugins

client.plugins().list(options) - List Plugins

+ filters - a JSON encoded value of the filters (a map[string][]string) to process on the services list.

client.plugins().install(options) - Install a Plugin

+ name - Name of the plugin to pull. The name may include a tag or digest. This parameter is required.

client.plugins().inspect(id, options) - Inspect a Plugin

client.plugins().enable(id, options) - Enable a Plugin

client.plugins().disable(id, options) - Disable a Plugin

client.plugins().remove(id, options) - Remove a Plugin

Services

client.services().list(options) - List Services

+ filters - a JSON encoded value of the filters (a map[string][]string) to process on the services list.

client.services().create(options, registryAuth) - Create a Service

client.services().remove(id, options) - Remove a Service

client.services().inspect(id, options) - Inspect a Service

client.services().logs(id, options) - Get Service Logs

+ details - boolean, Show extra details provided to logs. + follow - boolean, Return the logs as a stream. + stdout - boolean, Return logs from stdout + stderr - boolean, Return logs from stderr + since - number, Only return logs since this time, as a UNIX timestamp + timestamps - boolean, Add timestamps to every log line + tail - Only return this number of log lines from the end of the logs. Specify as an integer or all to output all log lines.

client.services().update(id, options, registryAuth) - Update a Service

+ version - The version number of the service object being updated. This is required to avoid conflicting writes.

Swarm

client.swarm().info(options) - Swarm Info

client.swarm().init(options) - Initialize a Swarm

client.swarm().join(options) - Join a Swarm

client.swarm().leave(options) - Leave a Swarm

+ force - Boolean (false/true). Force leave swarm, even if this is the last manager or that it will break the cluster.

client.swarm().update(options) - Update a Swarm

+ version - The version number of the swarm object being updated. This is required to avoid conflicting writes. + rotateWorkerToken - Set to true to rotate the worker join token. + rotateManagerToken - Set to true to rotate the manager join token.

Tasks

client.tasks().list(options) - List Services

+ filters - a JSON encoded value of the filters (a map[string][]string) to process on the tasks list.

client.tasks().inspect(id, options) - Inspect a Task

Volumes

client.volumes().list(options) - List Volumes

+ filters - a JSON encoded value of the filters (a map[string][]string) to process on the volumes list.

client.volumes().create(options, registryAuth) - Create a Volume

client.volumes().remove(id, options) - Remove a Volume

client.volumes().inspect(id, options) - Inspect a Volume

Secrets

client.secrets().list(options) - List Secret

+ filters - map[string][]string to process on the secrets list

client.secrets().create(model, options) - Create Secret

client.secrets().inspect(id, options) - Inspect Secret

client.secrets().remove(id, options) - Remove Secret

client.secrets().update(id, model, options) - Update Secret

  • Docker Documentation
  • id - the id or name of the secret
  • model - the JSON model that the Docker API consumes
  • options
+ version - The version number of the secret object being updated. This is required to avoid conflicting writes.

Daemon

client.info() - System Wide Information

client.auth(options) - Authentication Configuration

+ username + password + serveraddress

client.version() - Version

client.ping() - Ping Daemon

client.events() - Events Stream

+ since - Timestamp. Show all events created since timestamp and then stream + until - Timestamp. Show events created until given timestamp and stop streaming + filters - value of the filters (a map[string][]string) to process on the event list
🔗 More in this category
macrozheng
macrozheng/mall
mall项目是一套电商系统，包括前台商城系统及后台管理系统，基于Spring Boot+MyBatis实现，采用Docker容器化部署。 前台商城系统包含首页门户、商品推荐、商品搜索、商品展示、购物车、订单流程、会员中心、客户服务、帮助中心等模块。 后台管理系统包含商品管理、订单管理、会员管理、促销管理、运营管理、内容管理、统计报表、财务管理、权限管理、设置等模块。
★ 84.0k
 louislam
louislam/uptime-kuma
A fancy self-hosted monitoring tool
★ 88.9k
 Stirling-Tools
Stirling-Tools/Stirling-PDF
#1 PDF Application on GitHub that lets you edit PDFs on any device anywhere
★ 86.6k
 coollabsio
coollabsio/coolify
An open-source, self-hostable PaaS alternative to Vercel, Heroku & Netlify that lets you easily deploy static sites, databases, full-stack applications and 280+ one-click services on your own servers.
★ 58.2k
 mastodon
mastodon/mastodon
Your self-hosted, globally interconnected microblogging community
★ 50.1k
 dockur
dockur/windows
Windows inside a Docker container.
★ 52.4k
 alibaba
alibaba/nacos
an easy-to-use dynamic service discovery, configuration and service management platform for building AI cloud native applications.
★ 33.1k
 Kong
Kong/kong
🦍 The API and AI Gateway
★ 43.8k
 chatwoot
chatwoot/chatwoot
Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬
★ 34.3k
 ToolJet
ToolJet/ToolJet
ToolJet is the open-source foundation of ToolJet AI - the enterprise app generation platform for building internal tools, dashboard, business applications, workflows and AI agents 🚀
★ 38.2k
 outline
outline/outline
The fastest knowledge base for growing teams. Beautiful, realtime collaborative, feature packed, and markdown compatible.
★ 39.6k
 apache
apache/rocketmq
Apache RocketMQ is a cloud native messaging and streaming platform, making it simple to build event-driven applications.
★ 22.5k

© 2026 GitRepoTrend · arhea/harbor-master · Updated daily from GitHub