# docker-dashboard **Repository Path**: liangw/docker-dashboard ## Basic Information - **Project Name**: docker-dashboard - **Description**: 基于控制台的docker仪表盘。 - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: master - **Homepage**: https://github.com/pipiliang/docker-dashboard - **GVP Project**: No ## Statistics - **Stars**: 84 - **Forks**: 22 - **Created**: 2017-04-28 - **Last Updated**: 2024-05-02 ## Categories & Tags **Categories**: docker-related **Tags**: Docker, Docker-dashboard ## 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 git@github.com: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)