1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
# Simple Container
[](https://github.com/valentineus/simple-container/releases)
[](https://www.npmjs.com/package/simple-container)
[](https://travis-ci.org/valentineus/simple-container)
[](https://www.codacy.com/app/valentineus/simple-container)
[](https://www.codacy.com/app/valentineus/simple-container/files)
[](https://gitter.im/valentineus/simple-container)
Simple and fast work with the Docker container.
Works great in
[Travis CI](https://travis-ci.org/)
for testing
It uses the library
[dockerode](https://github.com/apocas/dockerode).
## Installation
```bash
npm install --save simple-container
```
## Using
A simple example that creates and starts a container:
```JavaScript
import Containers from 'simple-container';
var containers = new Containers();
containers.create('hello-world:latest').then(container => {
console.info(`The ${container.id} container was created.`);
start(container);
});
/* Run the created container */
function start(container) {
container.start().then(() => {
console.info(`The ${container.id} container is running.`);
});
}
```
### Remote connection
By default, the local service is used.
For example, if you want to use connection settings:
```JavaScript
var containers = new Containers({
host: '127.0.0.1',
port: 3000
});
```
Examples and details in
[the documentation](https://github.com/apocas/dockerode#getting-started).
### Creating a container
You can create a container in two ways.
A simple way - to specify the name of the image:
```JavaScript
containers.create('hello-world:latest');
```
Another way - to provide an object with parameters:
```JavaScript
containers.create({
Image: 'postgres:alpine',
Env: ['POSTGRES_PASSWORD = password'],
Ports: [{
IP: '0.0.0.0',
PrivatePort: 5432,
PublicPort: 5432,
Type: 'tcp'
}]
});
```
Examples and details in
[the documentation](https://github.com/apocas/dockerode#manipulating-a-container).
#### Third-party repository
An additional example of obtaining a private image:
```JavaScript
var auth = {
serveraddress: 'https://index.docker.io/v1',
email: 'email@example.org',
username: 'username',
password: 'password',
auth: ''
};
containers.create({
Image: 'project:latest',
authconfig: auth
});
```
Details in
[the documentation](https://github.com/apocas/dockerode#pull-from-private-repos).
## API
<dl>
<dt>
<a href="#create">create(options)</a> ⇒ <code>Promise</code>
</dt>
<dd>
<p>Creates a container by options or name, returning the management interface.</p>
</dd>
<dt>
<a href="#get">get([id])</a> ⇒ <code>Promise</code>
</dt>
<dd>
<p>Returns the container management interface.</p>
</dd>
<dt>
<a href="#info">info([id])</a> ⇒ <code>Promise</code>
</dt>
<dd>
<p>Searches in existing containers.</p>
</dd>
</dl>
<a name="create"></a>
### create(options) ⇒ <code>Promise</code>
Creates a container by options or name, returning the management interface.
| Param | Type | Description |
| --- | --- | --- |
| options | <code>String</code> \ <code>Object</code> | The name of the image or options |
<a name="get"></a>
### get([id]) ⇒ <code>Promise</code>
Returns the container management interface.
| Param | Type | Description |
| --- | --- | --- |
| [id] | <code>String</code> | Container ID |
#### Examples:
```JavaScript
containers.get().then(containers => {
/* containers - All containers in the system */
});
containers.get('5520e855dd2c301b23a718cf392f9619d1edc3dc0fa294559b725d7588ca807f').then(container => {
/* container - The specified container */
});
```
<a name="info"></a>
### info([id]) ⇒ <code>Promise</code>
Searches in existing containers.
| Param | Type | Description |
| --- | --- | --- |
| [id] | <code>String</code> | Container ID |
#### Examples:
```JavaScript
containers.info().then(containers => {
/* containers - All containers in the system */
});
containers.info('21ae4a54be582d13fffd796341b3561a8c8e0c59dd6c6c3239529188e2b3321d').then(container => {
/* container - The specified container */
});
```
## License
[](https://github.com/eslint/eslint)
[MIT](LICENSE.md).
Copyright (c)
[Valentin Popov](mailto:info@valentineus.link).
|
