https://github.com/tudvari/dockerfile-generator
Dockerfile Generator for Node.js
https://github.com/tudvari/dockerfile-generator
docker dockerfile-generator javascript json
Last synced: 3 months ago
JSON representation
Dockerfile Generator for Node.js
- Host: GitHub
- URL: https://github.com/tudvari/dockerfile-generator
- Owner: tudvari
- License: mit
- Created: 2015-11-29T12:07:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2026-02-26T08:27:35.000Z (3 months ago)
- Last Synced: 2026-02-26T13:41:37.818Z (3 months ago)
- Topics: docker, dockerfile-generator, javascript, json
- Language: JavaScript
- Homepage:
- Size: 1.27 MB
- Stars: 21
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# dockerfile-generator
Generating Dockerfile from JSON and generate JSON document from a Dockerfile.
[](https://badge.fury.io/js/dockerfile-generator)
## Latest release note
## Version 5.0.5 (14.03.2026)
- Update dependencies
- Migrate tests from mocha to jest
## Version 5.0.4 (21.12.2025)
- Update dependencies
## Version 5.0.3 (28.10.2024)
- Update dependencies
Release notes of previous versions: [Release notes](ReleaseNotes.md).
## Installation
```shell
npm install dockerfile-generator
```
## How to use the library
You can find here the reference doc: [References](References.md).
```Javascript
const generator = require('dockerfile-generator')
const result = await generator.generateDockerFile(inputJson)
// Result is a generated Dockerfile.
const generateResult = generator.generateDockerFileFromArray(inputArray)
// Result is a generated Dockerfile.
const convertedJSON = generator.convertToJSON(inputDockerFile)
// Result is a generated JSON from Dockerfile.
const genereratedIgnore = await generator.generateIgnoreFile(ignoredElementsArray)
// generatedIgnore is a generated dockerignore file
```
## Examples
##### Example for Dockerfile Generation JSON Input ( generateDockerFile function )
###### Input
```json
{
"from": "nginx:latest",
"run": [ "adduser", "--disabled-password", "-gecos", "", "testuser" ],
"volumes": [ "/home/testuser/app" ],
"user": "testuser",
"working_dir": "/home/testuser/app",
"labels": {
"name": "value"
},
"env": {
"env1": "value1",
"env2": "value2"
},
"add": {
"test.run" : "/home/testuser/app/test.run"
},
"copy": {
"test.cmd" : "/home/testuser/app/test.cmd"
},
"entrypoint": "tail",
"cmd": ["-f", "/dev/null"],
"expose": ["80/tcp"],
"args": [ "value1", "value2"],
"stopsignal": "stop",
"shell": [ "/bin/bash", "-c", "echo", "hello" ],
"comment": "This is a comment"
}
```
###### Output
```javascript
FROM nginx:latest
RUN [ "adduser", "--disabled-password", "-gecos", "", "testuser" ]
VOLUME /home/testuser/app
USER testuser
WORKDIR /home/testuser/app
LABEL name=value
ENV env1=value1
ENV env2=value2
ADD test.run /home/testuser/app/test.run
COPY test.cmd /home/testuser/app/test.cmd
ENTRYPOINT [ "tail" ]
CMD [ "-f", "/dev/null" ]
EXPOSE 80/tcp
ARG value1
ARG value2
STOPSIGNAL stop
SHELL [ "/bin/bash", "-c", "echo", "hello"]
# This is a comment
```
##### Example for Dockerfile Generation Array Input ( generateDockerFileFromArray function )
###### Input
```json
[
{
"from": "nginx:latest"
},
{
"run": [ "adduser", "--disabled-password", "-gecos", "", "testuser" ]
},
{
"volumes": [ "/home/testuser/app" ]
},
{
"user": "testuser"
},
{
"working_dir": "/home/testuser/app"
},
{
"labels": {
"name": "value"
}
},
{
"env": {
"env1": "value1",
"env2": "value2"
}
},
{
"add": {
"test.run" : "/home/testuser/app/test.run"
}
},
{
"copy": {
"test.cmd" : "/home/testuser/app/test.cmd"
}
},
{
"entrypoint": "tail"
},
{
"cmd": ["-f", "/dev/null"]
},
{
"expose": ["80/tcp"]
},
{
"args": [ "value1", "value2"]
},
{
"stopsignal": "stop"
},
{
"shell": [ "/bin/bash", "-c", "echo", "hello" ]
},
]
```
###### Output
```javascript
FROM nginx:latest
RUN [ "adduser", "--disabled-password", "-gecos", "", "testuser" ]
VOLUME /home/testuser/app
USER testuser
WORKDIR /home/testuser/app
LABEL name=value
ENV env1=value1
ENV env2=value2
ADD test.run /home/testuser/app/test.run
COPY test.cmd /home/testuser/app/test.cmd
ENTRYPOINT [ "tail" ]
CMD [ "-f", "/dev/null" ]
EXPOSE 80/tcp
ARG value1
ARG value2
STOPSIGNAL stop
SHELL [ "/bin/bash", "-c", "echo", "hello"]
```
#### Example for JSON Generation ( convertToJSON function )
##### Example Input
```javascript
FROM nginx:latest
RUN [ "adduser", "--disabled-password", "-gecos", "", "testuser" ]
VOLUME /home/testuser/app
USER testuser
WORKDIR /home/testuser/app
LABEL name=value
ENV env1=value1
ENV env2=value2
ADD test.run /home/testuser/app/test.run
COPY test.cmd /home/testuser/app/test.cmd
ENTRYPOINT [ "tail" ]
CMD [ "-f", "/dev/null" ]
EXPOSE 80/tcp
ARG value1
ARG value2
STOPSIGNAL stop
SHELL [ "/bin/bash", "-c", "echo", "hello"]
# This is a comment
```
##### Example Output
```json
{
"from": "nginx:latest",
"run": [ "adduser", "--disabled-password", "-gecos", "", "testuser" ],
"volumes": [ "/home/testuser/app" ],
"user": "testuser",
"working_dir": "/home/testuser/app",
"labels": {
"name": "value"
},
"env": {
"env1": "value1",
"env2": "value2"
},
"add": {
"test.run" : "/home/testuser/app/test.run"
},
"copy": {
"test.cmd" : "/home/testuser/app/test.cmd"
},
"entrypoint": "tail",
"cmd": ["-f", "/dev/null"],
"expose": ["80/tcp"],
"args": [ "value1", "value2"],
"stopsignal": "stop",
"shell": [ "/bin/bash", "-c", "echo", "hello" ],
"comment_1": "This is a comment"
}
```
#### Example for .dockerignore Generation ( generateIgnoreFile function )
##### Input
```javascript
['node_modules','.git']
```
##### Output
```javascript
node_modules
.git
```
### License
Copyright (c) 2015 Tibor Udvari. Released under the MIT license. See [LICENSE](https://github.com/tudvari/docker-composer/blob/master/LICENSE) for details.