# dockserv

> Simplified service manager using Docker containers

Latest version **0.1.0** (published 2016-07-06) · MIT license · 0 weekly downloads

## Install

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

Provides the commands `dserv`, `dockserv`.

## 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.0 |
| Published | 2016-07-06 |
| First published | 2016-07-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Isaac Whitfield |
| Maintainers | zackehh |

## Links

- npm: https://www.npmjs.com/package/dockserv
- Repository: https://github.com/zackehh/dockserv
- Homepage: https://github.com/zackehh/dockserv#readme
- Issues: http://github.com/zackehh/dockserv/issues
- npm.io page: https://npm.io/package/dockserv

## Dependencies (3)

- [commander](https://npm.io/package/commander.md) 2.9.0
- [dockerode](https://npm.io/package/dockerode.md) 2.2.10
- [dot-notes](https://npm.io/package/dot-notes.md) 3.1.1

## Recent versions

- 0.1.0 (latest) — 2016-07-06

## README

# dockserv

Simplified service manager using Docker containers.

### Installation

You should install this module globally, as it's designed to be a command line tool.

```bash
$ npm install -g zackehh/dockserv
```

### Basic Usage 

The basic idea is that you load definitions into `dockserv` to easily start/stop services. One such example is the below (for `mongodb`).

```javascript
module.exports = {
  image: 'mongo',
  binds: [
    '$DOCKSERV_DATA/mongodb:/data/db'
  ],
  env: [
    'FOO=bar'
  ],
  ports: [
    '27017'
  ]
};
```

Super simple, the above defines that we want to use the MongoDB image, bind the data directory, and forward port 27017. `$DOCKSERV_DATA` is equal to `$DOCKSERV_HOME/data`, and `$DOCKSERV_HOME` can be changed via `$ dserv set prefix <path>`.

Assuming the above lives in a file named `mongo.js`, you can load it into `dockserv` easily:

```bash
$ dserv add mongodb mongo.js
```

And at that point, you can start/stop as needed:

```bash
$ dserv start mongodb
$ dserv stop mongodb
$ dserv restart mongodb
```

You can also load definitions from a URL, for example:

```bash
$ dserv add mongodb https://gist.github.com/zackehh/f078940d29bf3f5fe8e4c5a568d06c48/raw/mongodb.js
```

### Commands

You can view all available commands using `$ dserv --help` until I get some documentation up and running, it should be pretty straightforward.

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