Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghostbuster91/nodejs-packager
Build container images for your Node.js applications.
https://github.com/ghostbuster91/nodejs-packager
command-line-tool docker docker-registry nodejs-server
Last synced: 12 days ago
JSON representation
Build container images for your Node.js applications.
- Host: GitHub
- URL: https://github.com/ghostbuster91/nodejs-packager
- Owner: ghostbuster91
- License: apache-2.0
- Created: 2021-01-05T13:49:16.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-02-27T19:15:24.000Z (over 3 years ago)
- Last Synced: 2024-10-05T03:01:09.197Z (about 1 month ago)
- Topics: command-line-tool, docker, docker-registry, nodejs-server
- Language: TypeScript
- Homepage:
- Size: 994 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nodejs-packager
This project draws inspiration from various projects from jvm ecosystem:
- [sbt-native-packager](https://github.com/sbt/sbt-native-packager)
- [jib](https://github.com/GoogleContainerTools/jib)
## Goals of the project
nodejs-packager primary goals is creating a Docker image which can “just run” your nodejs application. At the same time it tries to:
- follow best practices when packaging your application
- be concise
- be easy to use
- cover the most popular use-cases
Covering 100% of the use-cases is not a goal of that project. If you have a very specific setup consider getting back to plain `Dockerfile`.
Having said that, most common use-cases should be covered. If your use-case is not covered please file an issue and we can think what to do with it together.
## Usage
_Keep in mind that this project is still in experimental phase. Use it at your own risk!_
Install packager globally:
`npm install -g @ghostbuster91/nodejs-packager`
or add to your project:
`npm install --save-dev @ghostbuster91/nodejs-packager`
and add corresponding entries for each relevant command to the `scripts` section of your `package.json` e.g.:
```
"scripts": {
"docker-clean": "nodejs-packager clean",
"docker-stage": "nodejs-packager stage",
"docker-build": "nodejs-packager build",
"docker-publish": "nodejs-packager publish"
}
```
```
Usage: nodejs-packager [options] [command]
Options:
-v, --version output the version number
-l, --log-level log level (default: "INFO")
-c, --config config file name (default: "dockerconfig.ts")
-h, --help display help for command
Commands:
stage Generates a directory with the Dockerfile and environment prepared for building a Docker
image.
build [options] Builds an image using the local Docker server.
publish [options] Builds an image using the local Docker server and pubishes it to the remote repository
clean Deletes all the temporary files and removes built images from the local Docker server.
init Generates initial dockerconfig.ts for given template
help [command] display help for command
```
## Configuration
The minimal configuration looks as follows:
```
module.exports.userConfig = async () => {
return {
imageConfig: {
baseImage: "node:15-alpine",
entrypoint: ["node", "index.js"],
aliases: [],
}
}
}
```
Currently supported additional options for building images:
- `workdir?: string;`
- `exposedPorts?: number[];`
- `exposedUdpPorts?: number[];`
- `command?: string[];`
- `aliases: {name: string; tag: string;}[];`
- `dockerUpdateLatest?: boolean;`
- `template?: string;`
- `maintainer?: string;`
- `mappings?: { from: string; to: string;}[];`
- `envVars?: { key: string; value: string;}[];`
- `volumes?: string[];`
### Templates
Templates define how layers within the docker image are built. Currently there are only two of them: `NPM_JS` and `NPM_TS`. If neither of these is specified, default one is used (`NPM_JS`).
### Authorization
nodejs-packager will try to use daemon-wide credentials whenever possible. If this isn't an option for you, or it is insufficient you can provide additional credentials using `--auth` option.
## Releasing
Currently done manually through `np` (`npm install --global np`).
## Contributing
nodejs-packager is an early stage project. Everything might change. All suggestions welcome :)
See the list of [issues](https://github.com/ghostbuster91/nodejs-packager/issues) and pick one! Or report your own.
If you are having doubts on the why or how something works, don't hesitate to ask a question on gitter or via github. This probably means that the documentation or the code is unclear and should be improved for the benefit of all.