https://github.com/pipiliang/docker-dashboard

Console based docker dashboard
https://github.com/pipiliang/docker-dashboard

cli dashboard docker docker-dashboard typescript

Last synced: 3 months ago
JSON representation

Console based docker dashboard

• Host: GitHub
• URL: https://github.com/pipiliang/docker-dashboard
• Owner: pipiliang
• License: mit
• Created: 2017-04-28T09:45:18.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-29T13:25:41.000Z (about 4 years ago)
• Last Synced: 2024-10-01T09:49:18.887Z (4 months ago)
• Topics: cli, dashboard, docker, docker-dashboard, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/docker-dashboard
• Size: 1.23 MB
• Stars: 285
• Watchers: 11
• Forks: 34
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• Awesome-GitHub-Repo - docker-dashboard - 基于控制台的 docker 工具，代码简单易读，可以做为学习 Node.js 的实践项目。[<img src="https://tva1.sinaimg.cn/large/008i3skNly1gxlhtmg11mj305k05k746.jpg" alt="微信" width="18px" height="18px" />](https://mp.weixin.qq.com/s?__biz=MzUxNjg4NDEzNA%3D%3D&chksm=f9a1d4fbced65ded0e1856a1db7ce2e6f2c9e423de4428795644770bf2dbb9910874e1678b64&idx=1&mid=2247485234&scene=21&sn=e2ff671bbe9ff9c8a642ccc5793c266a#wechat_redirect) (开源工具 / Docker工具)

README

        
## Docker Dashboard [![npm version](https://badge.fury.io/js/docker-dashboard.svg)](https://www.npmjs.com/package/docker-dashboard) [![Build Status](https://travis-ci.org/pipiliang/docker-dashboard.svg?branch=master)](https://travis-ci.org/pipiliang/docker-dashboard) ![UT](https://github.com/pipiliang/docker-dashboard/workflows/UT/badge.svg?branch=master)

:computer::chart_with_upwards_trend:Console based docker dashboard, base on [blessed](https://github.com/chjj/blessed) and [blessed-contrib](https://github.com/yaronn/blessed-contrib).

![](./screenshot/ubuntu.gif)

## Install

```

$ npm install -g docker-dashboard

```

>Note: need to install the docker before use, and only support `unix socket`.

In the following environment test passed:

|OS|Docker|Nodejs|

|----|----|----|

|Ubuntu 16.04 LTS|v1.12.6|v8.10.0|

|Fedora 25|v1.12.6|v8.11.1|

**Other system and versions are not guaranteed.**

## Usage

```

$ docker-dashboard

```

## Shortcut

|shortcut|description|

|----|----|

|`D`| show node info, warm info and others.|

|`C`| show container list.|

|`I`| show image list.|

|`N`| show network list.|

|`V`| show volume list.|

|`H`| help.|

|`↑`| scroll up.|

|`↓`| scroll down.|

|`Enter`| select a container and show statistics.|

|`Q`| exit dashboard.|

> Support operation with mouse.

## Development

run with resource:

```shell

$ git clone [email protected]:pipiliang/docker-dashboard

$ cd docker-dashboard

$ npm i

$ npm run build

$ npm test

$ npm start

```

## Debug by VSCode

launch.json :

```json

{

    "version": "0.2.0",

    "configurations": [

        {

            "name": "Debug",

            "type": "node",

            "request": "launch",

            "args": [

                "${workspaceRoot}/src/index.ts"

            ],

            "runtimeArgs": [

                "--nolazy",

                "-r",

                "ts-node/register"

            ],

            "sourceMaps": true,

            "cwd": "${workspaceRoot}",

            "protocol": "inspector",

            "console": "integratedTerminal"

        }

    ]

}

```

## Thanks

- [blessed-contrib](https://github.com/yaronn/blessed-contrib)

- [blessed](https://github.com/chjj/blessed)

- [dockerode](https://github.com/apocas/dockerode)

## License

[![npm](https://img.shields.io/npm/l/express.svg)](https://github.com/pipiliang/made/blob/master/LICENSE)