# vxdocker

> Vortex Docker - seamless integration between Vortex and Docker on any platform.

Latest version **0.0.2** (published 2013-08-29) · MIT license · 0 weekly downloads

## Install

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

Provides the command `vxdocker`.

## 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.0.2 |
| Published | 2013-08-29 |
| First published | 2013-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Websecurify |
| Maintainers | websecurify |
| Keywords | vortex, docker |

## Links

- npm: https://www.npmjs.com/package/vxdocker
- Repository: https://github.com/websecurify/node-vxdocker
- Issues: https://github.com/websecurify/node-vxdocker/issues
- npm.io page: https://npm.io/package/vxdocker

## Dependencies (3)

- [vortex](https://npm.io/package/vortex.md) latest
- [logsmith](https://npm.io/package/logsmith.md) latest
- [portchecker](https://npm.io/package/portchecker.md) 0.1.2

## Recent versions

- 0.0.2 (latest) — 2013-08-29
- 0.0.1 — 2013-08-29

## README

__   ____  _____   ___   ___ _  _____ ___ 
	\ \ / /\ \/ /   \ / _ \ / __| |/ / __| _ \
	 \ V /  >  <| |) | (_) | (__| ' <| _||   /
	  \_/  /_/\_\___/ \___/ \___|_|\_\___|_|_\
	
	by Websecurify
	  
# Introduction

VxDocker is a [Vortex](http://www.websecurify.com/extra/vortex.html) wrapper for [Docker](http://www.docker.io/). The purpose of VxDocker is to make seamless integration between docker and operating systems, which do not support LXS containers such as Windows and Mac OS.

# Installation

The easiest way to install VxDocker is via node's npm. You need to have nodejs installed for this. Simply type the following command:

	npm install -g vxdocker

An alternative approach is to just copy the source files and execute them manually though nodejs.

# Usage

Once the tool is installed, it is as easy to use as docker itself. For example:

	vxdocker images 				# lists all images
	vxdocker run ubuntu ls -la 		# performs a list inside the ubuntu docker image

Essentially the docker command doesn't change, it is only mapped to vxdocker instead.

# Behind The Scenes

Behind the scenes, VxDocker uses Vortex to boot a virtual machine in VirtualBox and fire up docker itself. The first time you run the `vxdocker` command you will notice a delay. This is due to the booting of the virtual machine. The virtual machine will be automatically destroyed after 30 minutes of inactivity.

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