https://github.com/pipedrive/containerized
Detect whether your Node.js process is containerized — e.g. whether it runs inside a Docker container.
https://github.com/pipedrive/containerized
containers detect detection docker-container node nodejs
Last synced: 3 months ago
JSON representation
Detect whether your Node.js process is containerized — e.g. whether it runs inside a Docker container.
- Host: GitHub
- URL: https://github.com/pipedrive/containerized
- Owner: pipedrive
- License: mit
- Archived: true
- Created: 2015-09-23T22:27:23.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-02T11:20:14.000Z (about 3 years ago)
- Last Synced: 2024-12-16T23:23:49.920Z (about 1 year ago)
- Topics: containers, detect, detection, docker-container, node, nodejs
- Language: JavaScript
- Size: 403 KB
- Stars: 28
- Watchers: 134
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](http://badge.fury.io/js/containerized) [](https://travis-ci.org/pipedrive/containerized) [](https://coveralls.io/github/pipedrive/containerized?branch=master)
# Containerized - DEPRECATED (You can use following package instead: https://github.com/sindresorhus/is-docker)
* **Detect whether your Node.js process runs inside a Docker container or not**
* Detection is based on existence of Docker-specific cgroups
* Well tested (aiming at 100% line, function, statement and branch coverage)
* Works with all Node.js versions >= 0.10.x.
* Tested in 0.10.x, 4.x, 5.x, 6.x.
## Usage
```
npm install containerized
```
### Node.js versions 0.12, 4.x, 5.x, 6.x, ...
```javascript
var containerized = require('containerized');
if (containerized()) {
console.log('I am running inside a Docker container.');
} else {
console.log('I am NOT running inside a Docker container.');
}
```
### In Node.js 0.10.x
Up until node 0.10.x, containerized offers only async way of fetching whether the process is containerized in a container or not.
```javascript
var containerized = require('containerized');
containerized(function(err, result) {
if (result === true) {
console.log('I am running inside a Docker container.');
} else {
console.log('I am NOT running inside a Docker container.');
}
});
```
For synchronous interface in Node <= 0.10, wrap it in [deasync](https://www.npmjs.com/package/deasync) module:
```javascript
var deasync = require('deasync');
var containerized = deasync(require('containerized'));
// then you can:
if (containerized()) {
console.log('I am running inside a Docker container.');
}
```
## Licence
MIT.
## Contribute?
You're welcome! Make sure you keep an eye on the tests.