# everypaas

> Easily run your app on any PaaS such as Heroku, dotCloud, Nodejitsu

Latest version **0.0.8** (published 2016-02-03) · BSD license · 0 weekly downloads

## Install

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

## 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.8 |
| Published | 2016-02-03 |
| First published | 2012-08-25 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Niall O'Higgins |
| Maintainers | niallo |

## Links

- npm: https://www.npmjs.com/package/everypaas
- Repository: https://github.com/niallo/everypaas
- Issues: https://github.com/niallo/everypaas/issues
- npm.io page: https://npm.io/package/everypaas

## Dependencies (1)

- [step](https://npm.io/package/step.md) ~0.0.5

## Recent versions

- 0.0.8 (latest) — 2016-02-03
- 0.0.7 — 2012-10-18
- 0.0.6 — 2012-09-15
- 0.0.5 — 2012-08-25
- 0.0.4 — 2012-08-25
- 0.0.3 — 2012-08-25
- 0.0.2 — 2012-08-25
- 0.0.1 — 2012-08-25

## README

Every PaaS
==========

Considering running your Node.JS app on a Platform-as-a-Service provider such
as Heroku, dotCloud, Nodejitsu - or testing it with Travis or doing testing &
continuous deployment with Strider?

EveryPaaS handles all the annoying platform-specific details so that you don't
have to. EveryPaas also makes local development a breeze according to 12-factor
app best practices.

EveryPaaS detects which environment your app is running in and abstracts away
the details of how to connect to external resources.

If you write your app with EveryPaaS, you and your users will be able to
seamlessly run it on your dev box and any of a number of platform providers -
without changing a single line of code!

Supported Platforms
-------------------

* Heroku
* Nodejitsu
* Strider
* Travis CI
* dotCloud
* Your dev box

Supported Services
------------------

* MongoDB - `everypaas.getMongodbUrl()`
  - including MongoLab and MongoHQ in Heroku Marketplace

* MySQL - `everypaas.getMysqlUrl()`
  - including ClearDB and Xeround in Heroku Marketplace

* PostgreSQL - `everypaas.getPostgresqlUrl()`

* Redis - `everypaas.getRedisUrl()`
  - including Redis To Go and Open Redis in Heroku Marketplace

* Solr - `everypaas.getSolrUrl()`
  - including Web Solr in Heroku Marketplace

* SMTP - `everypaas.getSMTP()`
  - including SendGrid and Mailgun in Heroku Marketplace


Installation
------------

EveryPaaS is available in NPM. Simply type `npm install everypaas` to install
it.

Usage
-----

EveryPaaS has a very simple API. When you require EveryPaaS, it will detect
which environment it is running in.

Example:

```javascript
var everypaas = require('everypaas')

var mongodbUrl = everypaas.getMongodbUrl()
```

Complete API
------------

***Functions***

**MongoDB**

`everypaas.getMongodbUrl()` - Returns the URL for the MongoDB service. On Heroku, this will work with both MongoLab and MongoHQ add-ons.

**MySQL**

`everypaas.getMysqlUrl()` - Returns the URL for the MySQL service. On Heroku, this will work with both ClearDB and Xeround add-ons.

**PostgreSQL**

`everypaas.getPostgresqlUrl()` - Returns the URL for the PostgreSQL service.

**Redis**

`everypaas.getRedisUrl()` - Returns the URL for the Redis service. On Heroku, this will work with both Redis To Go and Open Redis add-ons.

**Solr**

`everypaas.getRedisUrl()` - Returns the URL for the Solr service. On Heroku, this will work with the Web Solr add-on.

**SMTP**

`everypaas.getSMTP()` - Returns an argument which can be applied to [nodemailer](https://github.com/andris9/Nodemailer) module `createTransport` function. On Heroku, this will work with both Mailgun and SendGrid add-ons. Example:

```javascript
var everypaas = require('everypaas')
var nodemailer = require('nodemailer')

var transport = nodemailer.createTransport.apply(null, everypaas.getSMTP())
transport.sendMail({
    from: "foo@example.com", // sender address
    to: "bar@example.com", // list of receivers
    subject: "EveryPaaS", // Subject line
    text: "NOMP stack FTW", // plaintext body_template
    html: "<html><body>NOMP stack FTW</body></html>" // html body
  }, function(err, response) {
    // handle success / failure
  })

```

***Properties***

`everypaas.paas` - The detected platform. Value is one of:

  - `everypaas.HEROKU` (Heroku)
  - `everypaas.DOTCLOUD` (dotCloud)
  - `everypaas.STRIDER` (Strider)
  - `everypaas.TRAVIS` (Travis)
  - `everypaas.NODEJITSU` (Nodejitsu)
  - `everypaas.NONE` (dev box / unknown)

`everypaas.herokuEnvironment` - Contains the full Heroku configuration environment.

`everypaas.dotCloudEnvironment` - Contains the full dotCloud configuration
environment. This can be useful to retrieve custom confuration variables or if
you have multiple instances of the same service.

`everypaas.striderEnvironment` - Contains the full Strider configuration
environment.


Tests
-----

EveryPaaS has a comprehensive test suite. This can be executed by running `npm test` in the project root.

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