# dockermon

> Docker monitoring utility

Latest version **0.1.2** (published 2014-10-30) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install dockermon
pnpm add dockermon
yarn add dockermon
bun add dockermon
```

Provides the command `dockermon`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.2 |
| Published | 2014-10-30 |
| First published | 2014-10-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Jason Worley |
| Maintainers | jasonincode |
| Keywords | docker, utility, monitoring |

## Links

- npm: https://www.npmjs.com/package/dockermon
- Repository: https://github.com/jworley/dockermon
- Issues: https://github.com/jworley/dockermon/issues
- npm.io page: https://npm.io/package/dockermon

## Dependencies (9)

- [async](https://npm.io/package/async.md) ^0.9.0
- [debug](https://npm.io/package/debug.md) ^2.1.0
- [later](https://npm.io/package/later.md) ^1.1.6
- [yargs](https://npm.io/package/yargs.md) ^1.3.2
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.0
- [jstream](https://npm.io/package/jstream.md) ^0.2.7
- [dockerode](https://npm.io/package/dockerode.md) ^2.0.3
- [dockerode-options](https://npm.io/package/dockerode-options.md) ~0.1.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.1.2 (latest) — 2014-10-30
- 0.1.1 — 2014-10-25

## README

# dockermon

[![Dependencies](http://img.shields.io/david/jworley/dockermon.svg?style=flat-square)][david]
[![Build Status](http://img.shields.io/travis/jworley/dockermon.svg?style=flat-square)][build]
[![Code coverage](http://img.shields.io/codecov/c/github/jworley/dockermon.svg?style=flat-square)][codecov]
[![NPM Version](http://img.shields.io/npm/v/dockermon.svg?style=flat-square)][npm]
[![Github Version](http://img.shields.io/github/release/jworley/dockermon.svg?style=flat-square)][releases]

`dockermon` is a monitoring tool for [Docker][docker]. dockermon allows for the execution of Javascript modules in response to docker events or the rendering of templates.

## Installation

dockermon can be installed from NPM using:

```
$ npm install -g dockermon
```

There are also a binary version of available in the [releases][releases].
Download the binary, untar it, and add it to you PATH

```
$ wget https://github.com/jworley/dockermon/releases/download/v0.1.1/dockermon-linux-amd64-0.1.1.tar.gz
$ tar -zxvf dockermon-linux-amd64-0.1.1.tar.gz
$ ./dockermon
```

## Usage

```
Usage: dockermon [options] -i <source>

Options:
  --input, -i           Either as .js file to execute on change or a .jst template to generate on change                  [default: ""]
  --output, -o          Location to output result to in file system. The output is sent to stdout if not specified      
  --help, -h            Show this help documentation                                                                    
  --version, -v         Display version number                                                                          
  --endpoint, -e        Docker Remote API endpoint. This will default to the value of `DOCKER_HOST`                       [default: "/var/run/docker.sock"]
  --interval, -I        Regenerate from input at given interval (either provided as number of seconds or as CRON string)  [default: 0]
  --notify, -n          Run command after template or module has been ran                                               
  --only-exposed, -x    Only include containers with exposed ports                                                        [default: false]
  --only-published, -p  Only include containers with published ports                                                      [default: false]
  --watch, -w           Run continuously and monitors Docker container events                                           
  --force, -f           Run input even if no containers are found                                                         [default: true]
```

## Documentation

Documentation is available in the [Wiki][wiki]

## Donations

I code, therefore I am. To be honest I'd be writing this regardless but if you want to say thanks it would be greatly appreciated.

[![Gratipay](http://img.shields.io/gratipay/indyjworley.svg?style=flat-square)][gratipay]
[![Donate Coins](http://img.shields.io/badge/donate-coins-blue.svg?style=flat-square)][coins]

## License

[Apache 2.0][license]

[docker]: https://docker.com
[releases]: https://github.com/jworley/dockermon/releases
[npm]: https://www.npmjs.org/package/dockermon
[david]: https://david-dm.org/jworley/dockermon
[wiki]: https://github.com/jworley/dockermon/wiki
[license]: https://github.com/jworley/dockermon/blob/master/LICENSE
[gratipay]: https://gratipay.com/indyjworley/
[coins]: http://gravaco.in/741ca5ac451e12b8b1c50f285b7ccc2a
[build]: https://travis-ci.org/jworley/dockermon
[codecov]: https://codecov.io/github/jworley/dockermon

---
_Source: https://npm.io/package/dockermon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._