PM2 port number express app - node.js

ecosystem.config.js
module.exports = {
/**
* Application configuration section
* http://pm2.keymetrics.io/docs/usage/application-declaration/
*/
apps : [
// First application
{
name : 'cms_stage',
script : 'www',
env: {
COMMON_VARIABLE: 'true',
PORT: 3001,
NODE_ENV: 'staging'
}
}
]
}
I have an express app when i start with PORT=3001 node www, it works. But with pm2 above config it doesn't. pm2 show started but it is not listening to 3001
I tried running PORT=3001 pm2 start cms_stage, pm2 start cms_stage and pm2 start ecosystem.config.js.
reading port number like this app.set('port', process.env.PORT || 3000) in app.js

worked after killing pm2 with pm2 kill

Related

after deploying in heroku an error was popped up [duplicate]

I have my first node.js app (runs fine locally) - but I am unable to deploy it via heroku (first time w/ heroku as well). The code is below. SO doesn't let me write so much code, so I would just say that the running the code locally as well within my network shows no issue.
var http = require('http');
var fs = require('fs');
var path = require('path');
http.createServer(function (request, response) {
console.log('request starting for ');
console.log(request);
var filePath = '.' + request.url;
if (filePath == './')
filePath = './index.html';
console.log(filePath);
var extname = path.extname(filePath);
var contentType = 'text/html';
switch (extname) {
case '.js':
contentType = 'text/javascript';
break;
case '.css':
contentType = 'text/css';
break;
}
path.exists(filePath, function(exists) {
if (exists) {
fs.readFile(filePath, function(error, content) {
if (error) {
response.writeHead(500);
response.end();
}
else {
response.writeHead(200, { 'Content-Type': contentType });
response.end(content, 'utf-8');
}
});
}
else {
response.writeHead(404);
response.end();
}
});
}).listen(5000);
console.log('Server running at http://127.0.0.1:5000/');
Any idea ?
Heroku dynamically assigns your app a port, so you can't set the port to a fixed number. Heroku adds the port to the env, so you can pull it from there. Switch your listen to this:
.listen(process.env.PORT || 5000)
That way it'll still listen to port 5000 when you test locally, but it will also work on Heroku. Important note - PORT word must be capital.
You can check out the Heroku docs on Node.js here.
It's worth mentioning that if your code doesn't specify a port, then it shouldn't be a web process and probably should be a worker process instead.
So, change your Procfile to read (with your specific command filled in):
worker: YOUR_COMMAND
and then also run on CLI:
heroku scale worker=1
For those that are passing both a port and a host, keep in mind that Heroku will not bind to localhost.
You must pass 0.0.0.0 for host.
Even if you're using the correct port. We had to make this adjustment:
# port (as described above) and host are both wrong
const host = 'localhost';
const port = 3000;
# use alternate localhost and the port Heroku assigns to $PORT
const host = '0.0.0.0';
const port = process.env.PORT || 3000;
Then you can start the server, as usual:
app.listen(port, host, function() {
console.log("Server started.......");
});
You can see more details here: https://help.heroku.com/P1AVPANS/why-is-my-node-js-app-crashing-with-an-r10-error
The error happens when Heroku failed to bind the port or hostname at server.listen(port, [host], [backlog], [callback]).
What Heroku requires is .listen(process.env.PORT) or .listen(process.env.PORT, '0.0.0.0')
So more generically, to support other environments, use this:
var server_port = process.env.YOUR_PORT || process.env.PORT || 80;
var server_host = process.env.YOUR_HOST || '0.0.0.0';
server.listen(server_port, server_host, function() {
console.log('Listening on port %d', server_port);
});
I had same issue while using yeoman's angular-fullstack generated project and removing the IP parameter worked for me.
I replaced this code
server.listen(config.port, config.ip, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
with
server.listen(config.port, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
In my case, I was using example from https://hapijs.com/
To fix the problem I replaced
server.connection({
host: 'localhost',
port: 8000
});
with
server.connection({
port: process.env.PORT || 3000
});
change this line
app.listen(port);
to
app.listen(process.env.PORT, '0.0.0.0');
it will work
While most of the answers here are valid, for me the issue was that I was running long processes as part of npm run start which caused the timeout.
I found the solution here and to summarize it, I just had to move npm run build to a postinstall task.
In other words, I changed this:
"start": "npm run build && node server.js"
to this:
"postinstall": "npm run build",
"start": "node server.js"
Come to think of this, it totally makes sense because this error (which used to appear occasionally) was becoming more and more common as my app kept growing.
Changing my listening port from 3000 to (process.env.PORT || 5000) solved the problem.
Restarting all dynos in heroku did the trick for me
In my case, I was using Babel with the babel-plugin-transform-inline-environment-variables plugin. Apparently, Heroku does not set the PORT env variable when doing a deployment, so process.env.PORT will be replaced by undefined, and your code will fallback to the development port which Heroku does not know anything about.
I realized that I don't need the port number in the request endpoint, so the endpoint was herokuapp.com and not herokuapp.com:5000.
The listen() call can be without host and callback:
server.listen(5000);
I Use ReactJs,
If you want upload to heroku add this in your webpack.config.js
Because if not add you will have error
Error R10 (Boot timeout) -> Web process failed to bind to $PORT within
60 seconds of launch
//webpack.config.js add code like that
const HtmlWebPackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
var server_port = process.env.YOUR_PORT || process.env.PORT || 5000;
var server_host = process.env.YOUR_HOST || "0.0.0.0";
module.exports = {
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: "babel-loader"
}
},
{
test: /\.css$/,
use: [MiniCssExtractPlugin.loader, "css-loader"]
}
]
},
devServer: {
disableHostCheck: true,
contentBase: "./ dist",
compress: true,
inline: true,
port: server_port,
host: server_host
},
plugins: [
new HtmlWebPackPlugin({
template: "./src/index.html",
filename: "index.html"
}),
new MiniCssExtractPlugin({
filename: "[name].css",
chunkFilename: "[id].css"
})
]
};
I had the same issue because I didn't define Procfile. Commit a text file to your app's root directory that is named Procfile without a file extension. This file tells Heroku which command(s) to run to start your app.
web: node app.js
Edit package.json:
...
"engines": {
"node": "5.0.0",
"npm": "4.6.1"
},
...
and Server.js:
...
var port = process.env.PORT || 3000;
app.listen(port, "0.0.0.0", function() {
console.log("Listening on Port 3000");
});
...
I've spent a lot of hours to find the root cause, and eventually I've found that this timeout (60s) can be adjustable. Here you may change 60 second to 120 or even more. It works for me, hope will help anybody else!
To resolve this follow these Four simple steps:
in the package.json file:
1- set the main field to the server file:
"main": "server.js" // <-- here set you server file
2- add the host parameter to the app.listen function
const port = process.env.PORT || 3000;
const host = '0.0.0.0'
app.listen(port, host, ()=> connsole.log(`server is running on port ${port}`)
3- add the postinstall script to package.json file
"scripts": {
"postinstall": "npm run build", // <-- add this line
"start": "node server.js" // <-- change server.js to you main file
}
4- add the engines field in package.json file
"engines": {
"node": ">=14.0.O", // <-- change it to your node version. you can "node -v" in you command line
"npm": ">=7.7.0" // <-- change this to your npm version. you can use "npm -v" in the command line to get your npm version
}
let me know if you have any succes with this!
Use process.env.PORT || 3000 for your port.
This will use Heroku's port when available or use port 3000 if it's not available (for example, local testing)
You can change 3000 to whatever you want, for example 8080
In your package.json file, in the scripts, make sure your start script contains -p $PORT.
Example of package.json (in this case, for NextJS app):
{
"private": true,
"scripts": {
"dev": "next dev -p 3001",
"build": "next build",
"start": "next start -p $PORT" // make sure to have -p $PORT in here
},
"dependencies": {
"typescript": "^4.3.2"
},
"devDependencies": {
"#next/eslint-plugin-next": "^11.1.2",
"#types/mongoose": "^5.11.97"
"typescript": "^4.3.2"
}
"license": "MIT"
}
I had same issue I could resolved issue with replace 'localhost' with IP which is '0.0.0.0'
In my case, neither the port nor the host was the problem. The index.js was divided into 2 files. server.js:
//server.js
const express = require('express')
const path = require('path')
const app = express()
app.use(express.static(path.resolve(__dirname, 'public')));
// and all the other stuff
module.exports = app
//app.js
const app = require('./server');
const port = process.env.PORT || 3000;
app.listen(port, '0.0.0.0', () => {
console.log('Server is running s on port: ' + port)
});
from package.json we ran node app.js.
Apparently that was the problem. Once I combined the two into one file, the Heroku app deployed as expected.
I have the same issue but my environment variables are set well and the version of npm and node is specified in package.json. I figured out it is because, in my case, Heroku needs "start" to be specified in package.json:
"scripts": {
"start": "node index.js"
}
After adding this to my package.json my node app is successfully deployed on Heroku.
While developing the application we need to define the PORT in the following way:
const port = process.env.PORT || 4000; // PORT must be in caps
And while deploying the app to server add the following method:
app.listen(port, () => {
console.info("Server started listening.");
});
We can pass hostname as second parameter while running it in local. But while deploying it to server the hostname parameter should be removed.
app.listen(port, hostName, () => {
console.info(`Server listening at http://${hostName}:${port}`);
});
My case was that I was running Database scripts on start up and were taking long time. I solved this by manually running npm start after deployment is complete.
A fixed number can't be set for port, heroku assigns it dynamically using process.env.PORT. But you can add them both, like this process.env.PORT || 5000. Heroku will use the first one, and your localhost will use the second one.
You can even add your call back function. Look at the code below
app.listen(process.env.PORT || 5000, function() {
console.log("Server started.......");
});
At of all the solution i have tried no one work as expected, i study heroku by default the .env File should maintain the convention PORT, the process.env.PORT, heroku by default will look for the Keyword PORT.
Cancel any renaming such as APP_PORT= instead use PORT= in your env file.
From the heroku bash process, pass down the value of $PORT to your node app using an options parser like yargs.
Here is an example of how you might do that. On the scripts object, inside package.json, add a start method "node server --port $PORT".
In your server file, use yargs to get the value from the port option (--port $PORT) of the start method:
const argv = require('yargs').argv;
const app = require('express')();
const port = argv.port || 8081;
app.listen(argv.port, ()=>{
console.log('Probably listening to heroku $PORT now ', argv.port); // unless $PORT is undefined, in which case you're listening to 8081.
});
Now when your app starts, it will bind to the dynamically set value of $PORT.
If, like me, you're configuring Heroku to run a script from your package.json file on deploy, make sure you haven't hard-coded the value of PORT in that script! If you do, you'll end up like me and spend an hour trying to figure out why you're getting this error.
I had same issue but with express and apollo-server. The solution from here:
The only special consideration that needs to be made is to allow
heroku to choose the port that the server is deployed to. Otherwise,
there may be errors, such as a request timeout.
To configure apollo-server to use a port defined by Heroku at runtime,
the listen function in your setup file can be called with a port
defined by the PORT environment variable:
> server.listen({ port: process.env.PORT || 4000 }).then(({ url }) => {
> console.log(`Server ready at ${url}`); });
In my case I had two issues...
1) no listener at all because of running app from another entry file and this run script was deleted from package.json "scripts"
2) Case sensitive problem with 'Sequelize' instead of 'sequelize'

App crashed after nodejs app is deployed to heroku [duplicate]

I have my first node.js app (runs fine locally) - but I am unable to deploy it via heroku (first time w/ heroku as well). The code is below. SO doesn't let me write so much code, so I would just say that the running the code locally as well within my network shows no issue.
var http = require('http');
var fs = require('fs');
var path = require('path');
http.createServer(function (request, response) {
console.log('request starting for ');
console.log(request);
var filePath = '.' + request.url;
if (filePath == './')
filePath = './index.html';
console.log(filePath);
var extname = path.extname(filePath);
var contentType = 'text/html';
switch (extname) {
case '.js':
contentType = 'text/javascript';
break;
case '.css':
contentType = 'text/css';
break;
}
path.exists(filePath, function(exists) {
if (exists) {
fs.readFile(filePath, function(error, content) {
if (error) {
response.writeHead(500);
response.end();
}
else {
response.writeHead(200, { 'Content-Type': contentType });
response.end(content, 'utf-8');
}
});
}
else {
response.writeHead(404);
response.end();
}
});
}).listen(5000);
console.log('Server running at http://127.0.0.1:5000/');
Any idea ?
Heroku dynamically assigns your app a port, so you can't set the port to a fixed number. Heroku adds the port to the env, so you can pull it from there. Switch your listen to this:
.listen(process.env.PORT || 5000)
That way it'll still listen to port 5000 when you test locally, but it will also work on Heroku. Important note - PORT word must be capital.
You can check out the Heroku docs on Node.js here.
It's worth mentioning that if your code doesn't specify a port, then it shouldn't be a web process and probably should be a worker process instead.
So, change your Procfile to read (with your specific command filled in):
worker: YOUR_COMMAND
and then also run on CLI:
heroku scale worker=1
For those that are passing both a port and a host, keep in mind that Heroku will not bind to localhost.
You must pass 0.0.0.0 for host.
Even if you're using the correct port. We had to make this adjustment:
# port (as described above) and host are both wrong
const host = 'localhost';
const port = 3000;
# use alternate localhost and the port Heroku assigns to $PORT
const host = '0.0.0.0';
const port = process.env.PORT || 3000;
Then you can start the server, as usual:
app.listen(port, host, function() {
console.log("Server started.......");
});
You can see more details here: https://help.heroku.com/P1AVPANS/why-is-my-node-js-app-crashing-with-an-r10-error
The error happens when Heroku failed to bind the port or hostname at server.listen(port, [host], [backlog], [callback]).
What Heroku requires is .listen(process.env.PORT) or .listen(process.env.PORT, '0.0.0.0')
So more generically, to support other environments, use this:
var server_port = process.env.YOUR_PORT || process.env.PORT || 80;
var server_host = process.env.YOUR_HOST || '0.0.0.0';
server.listen(server_port, server_host, function() {
console.log('Listening on port %d', server_port);
});
I had same issue while using yeoman's angular-fullstack generated project and removing the IP parameter worked for me.
I replaced this code
server.listen(config.port, config.ip, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
with
server.listen(config.port, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
In my case, I was using example from https://hapijs.com/
To fix the problem I replaced
server.connection({
host: 'localhost',
port: 8000
});
with
server.connection({
port: process.env.PORT || 3000
});
change this line
app.listen(port);
to
app.listen(process.env.PORT, '0.0.0.0');
it will work
While most of the answers here are valid, for me the issue was that I was running long processes as part of npm run start which caused the timeout.
I found the solution here and to summarize it, I just had to move npm run build to a postinstall task.
In other words, I changed this:
"start": "npm run build && node server.js"
to this:
"postinstall": "npm run build",
"start": "node server.js"
Come to think of this, it totally makes sense because this error (which used to appear occasionally) was becoming more and more common as my app kept growing.
Changing my listening port from 3000 to (process.env.PORT || 5000) solved the problem.
Restarting all dynos in heroku did the trick for me
In my case, I was using Babel with the babel-plugin-transform-inline-environment-variables plugin. Apparently, Heroku does not set the PORT env variable when doing a deployment, so process.env.PORT will be replaced by undefined, and your code will fallback to the development port which Heroku does not know anything about.
I realized that I don't need the port number in the request endpoint, so the endpoint was herokuapp.com and not herokuapp.com:5000.
The listen() call can be without host and callback:
server.listen(5000);
I Use ReactJs,
If you want upload to heroku add this in your webpack.config.js
Because if not add you will have error
Error R10 (Boot timeout) -> Web process failed to bind to $PORT within
60 seconds of launch
//webpack.config.js add code like that
const HtmlWebPackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
var server_port = process.env.YOUR_PORT || process.env.PORT || 5000;
var server_host = process.env.YOUR_HOST || "0.0.0.0";
module.exports = {
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: "babel-loader"
}
},
{
test: /\.css$/,
use: [MiniCssExtractPlugin.loader, "css-loader"]
}
]
},
devServer: {
disableHostCheck: true,
contentBase: "./ dist",
compress: true,
inline: true,
port: server_port,
host: server_host
},
plugins: [
new HtmlWebPackPlugin({
template: "./src/index.html",
filename: "index.html"
}),
new MiniCssExtractPlugin({
filename: "[name].css",
chunkFilename: "[id].css"
})
]
};
I had the same issue because I didn't define Procfile. Commit a text file to your app's root directory that is named Procfile without a file extension. This file tells Heroku which command(s) to run to start your app.
web: node app.js
Edit package.json:
...
"engines": {
"node": "5.0.0",
"npm": "4.6.1"
},
...
and Server.js:
...
var port = process.env.PORT || 3000;
app.listen(port, "0.0.0.0", function() {
console.log("Listening on Port 3000");
});
...
I've spent a lot of hours to find the root cause, and eventually I've found that this timeout (60s) can be adjustable. Here you may change 60 second to 120 or even more. It works for me, hope will help anybody else!
To resolve this follow these Four simple steps:
in the package.json file:
1- set the main field to the server file:
"main": "server.js" // <-- here set you server file
2- add the host parameter to the app.listen function
const port = process.env.PORT || 3000;
const host = '0.0.0.0'
app.listen(port, host, ()=> connsole.log(`server is running on port ${port}`)
3- add the postinstall script to package.json file
"scripts": {
"postinstall": "npm run build", // <-- add this line
"start": "node server.js" // <-- change server.js to you main file
}
4- add the engines field in package.json file
"engines": {
"node": ">=14.0.O", // <-- change it to your node version. you can "node -v" in you command line
"npm": ">=7.7.0" // <-- change this to your npm version. you can use "npm -v" in the command line to get your npm version
}
let me know if you have any succes with this!
Use process.env.PORT || 3000 for your port.
This will use Heroku's port when available or use port 3000 if it's not available (for example, local testing)
You can change 3000 to whatever you want, for example 8080
In your package.json file, in the scripts, make sure your start script contains -p $PORT.
Example of package.json (in this case, for NextJS app):
{
"private": true,
"scripts": {
"dev": "next dev -p 3001",
"build": "next build",
"start": "next start -p $PORT" // make sure to have -p $PORT in here
},
"dependencies": {
"typescript": "^4.3.2"
},
"devDependencies": {
"#next/eslint-plugin-next": "^11.1.2",
"#types/mongoose": "^5.11.97"
"typescript": "^4.3.2"
}
"license": "MIT"
}
I had same issue I could resolved issue with replace 'localhost' with IP which is '0.0.0.0'
In my case, neither the port nor the host was the problem. The index.js was divided into 2 files. server.js:
//server.js
const express = require('express')
const path = require('path')
const app = express()
app.use(express.static(path.resolve(__dirname, 'public')));
// and all the other stuff
module.exports = app
//app.js
const app = require('./server');
const port = process.env.PORT || 3000;
app.listen(port, '0.0.0.0', () => {
console.log('Server is running s on port: ' + port)
});
from package.json we ran node app.js.
Apparently that was the problem. Once I combined the two into one file, the Heroku app deployed as expected.
I have the same issue but my environment variables are set well and the version of npm and node is specified in package.json. I figured out it is because, in my case, Heroku needs "start" to be specified in package.json:
"scripts": {
"start": "node index.js"
}
After adding this to my package.json my node app is successfully deployed on Heroku.
While developing the application we need to define the PORT in the following way:
const port = process.env.PORT || 4000; // PORT must be in caps
And while deploying the app to server add the following method:
app.listen(port, () => {
console.info("Server started listening.");
});
We can pass hostname as second parameter while running it in local. But while deploying it to server the hostname parameter should be removed.
app.listen(port, hostName, () => {
console.info(`Server listening at http://${hostName}:${port}`);
});
My case was that I was running Database scripts on start up and were taking long time. I solved this by manually running npm start after deployment is complete.
A fixed number can't be set for port, heroku assigns it dynamically using process.env.PORT. But you can add them both, like this process.env.PORT || 5000. Heroku will use the first one, and your localhost will use the second one.
You can even add your call back function. Look at the code below
app.listen(process.env.PORT || 5000, function() {
console.log("Server started.......");
});
At of all the solution i have tried no one work as expected, i study heroku by default the .env File should maintain the convention PORT, the process.env.PORT, heroku by default will look for the Keyword PORT.
Cancel any renaming such as APP_PORT= instead use PORT= in your env file.
From the heroku bash process, pass down the value of $PORT to your node app using an options parser like yargs.
Here is an example of how you might do that. On the scripts object, inside package.json, add a start method "node server --port $PORT".
In your server file, use yargs to get the value from the port option (--port $PORT) of the start method:
const argv = require('yargs').argv;
const app = require('express')();
const port = argv.port || 8081;
app.listen(argv.port, ()=>{
console.log('Probably listening to heroku $PORT now ', argv.port); // unless $PORT is undefined, in which case you're listening to 8081.
});
Now when your app starts, it will bind to the dynamically set value of $PORT.
If, like me, you're configuring Heroku to run a script from your package.json file on deploy, make sure you haven't hard-coded the value of PORT in that script! If you do, you'll end up like me and spend an hour trying to figure out why you're getting this error.
I had same issue but with express and apollo-server. The solution from here:
The only special consideration that needs to be made is to allow
heroku to choose the port that the server is deployed to. Otherwise,
there may be errors, such as a request timeout.
To configure apollo-server to use a port defined by Heroku at runtime,
the listen function in your setup file can be called with a port
defined by the PORT environment variable:
> server.listen({ port: process.env.PORT || 4000 }).then(({ url }) => {
> console.log(`Server ready at ${url}`); });
In my case I had two issues...
1) no listener at all because of running app from another entry file and this run script was deleted from package.json "scripts"
2) Case sensitive problem with 'Sequelize' instead of 'sequelize'

pm2 + KOA process.send is undefined

I am trying to accomplish the "graceful start" with pm2, but somehow my process.send is always undefined.
I am using esm module and start my application with yarn start
I am logging the process.send, but somehow it is always undefined.
app.listen(port, () => {
console.log('process.send', process.send);
console.log(`Server running on port ${port}`);
});
Where could be the problem?
Thanks and best regards
I had the same issue with an application using npm start as script in pm2.
I guess pm2 needs to start the application with an internal child process in node to make process.send('ready') work.
Changing to "script": "./dist/main.js" for pm2 made it work for me.
So maybe changing your config and application to something like this:
module.exports = {
apps: [
{
name: 'myApp',
script: './dist/main.js',
time: true,
listen_timeout: 10000,
env: { environment: 'production', NODE_ENV: 'production', },
}
],
};
(Depending of the output from your build)

PM2 Script Not Found for bin/www

Recently i decided to run my app with pm2 as a service. For me pm2 start app.mjs runs the app as a service but it seems pm2 doesn't run my express application correctly. I used express npm to build an app like this:
//Imports
import express from "express";
//Setups
const app = express();
const port = process.env.PORT;
app.get("/", async (req, res) => {
res.send("Hello world!");
});
//Running server
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
Also tried pm2 start ./bin/www that gives me an Script not found error and it seems to be okay with express-generator not the express npm alongside an app. App works correctly in dev mode (node app.mjs).
UPDATE
I solved the problem with help of Konstantinos Lamogiannis. After setup the config file as well as the answer, i changed my app.mjs to app.js form and changed the import style to const variable = require(""); and it fixed my problem. I don't know why that happened but it seems the pm2 npm may confilct with new nodejs feature which supports the import ES6 syntax.
pm2 log was giving to me this error: unhandledRejection you may have forgotten to catch a Promise rejection !
You can try creating a file with name: ecosystem.config.js in your projects root folder and then add the following code in the file:
module.exports = {
apps: [{
name: 'yourAppName',
script: 'bin/www/app.mjs', // the path of the script you want to execute,
// Options reference: https://pm2.keymetrics.io/docs/usage/application-declaration/
instances: 1,
autorestart: true,
watch: false,
error_file: 'err.log',
out_file: 'out.log',
log_file: 'combined.log',
time: true,
env: {
},
}],
};
In the config above you will notice that in script property its value is bin/www/app.mjs. I assume that you have app.mjs under bin/www directory and placed that value.
Then run pm2-runtime start ecosystem.config.js
EDIT #1
Assuming that your startup file is in your project's root directory use script: 'app.mjs'.
So your final ecosystem.config.js will be:
module.exports = {
apps: [{
name: 'yourAppName',
script: 'app.mjs', // the path of the script you want to execute,
// Options reference: https://pm2.keymetrics.io/docs/usage/application-declaration/
instances: 1,
autorestart: true,
watch: false,
error_file: 'err.log',
out_file: 'out.log',
log_file: 'combined.log',
time: true,
env: {
},
}],
};
Try then pm2-runtime start ecosystem.config.js from your root's project directory (where app.mjs is located).

Heroku + node.js error (Web process failed to bind to $PORT within 60 seconds of launch)

I have my first node.js app (runs fine locally) - but I am unable to deploy it via heroku (first time w/ heroku as well). The code is below. SO doesn't let me write so much code, so I would just say that the running the code locally as well within my network shows no issue.
var http = require('http');
var fs = require('fs');
var path = require('path');
http.createServer(function (request, response) {
console.log('request starting for ');
console.log(request);
var filePath = '.' + request.url;
if (filePath == './')
filePath = './index.html';
console.log(filePath);
var extname = path.extname(filePath);
var contentType = 'text/html';
switch (extname) {
case '.js':
contentType = 'text/javascript';
break;
case '.css':
contentType = 'text/css';
break;
}
path.exists(filePath, function(exists) {
if (exists) {
fs.readFile(filePath, function(error, content) {
if (error) {
response.writeHead(500);
response.end();
}
else {
response.writeHead(200, { 'Content-Type': contentType });
response.end(content, 'utf-8');
}
});
}
else {
response.writeHead(404);
response.end();
}
});
}).listen(5000);
console.log('Server running at http://127.0.0.1:5000/');
Any idea ?
Heroku dynamically assigns your app a port, so you can't set the port to a fixed number. Heroku adds the port to the env, so you can pull it from there. Switch your listen to this:
.listen(process.env.PORT || 5000)
That way it'll still listen to port 5000 when you test locally, but it will also work on Heroku. Important note - PORT word must be capital.
You can check out the Heroku docs on Node.js here.
It's worth mentioning that if your code doesn't specify a port, then it shouldn't be a web process and probably should be a worker process instead.
So, change your Procfile to read (with your specific command filled in):
worker: YOUR_COMMAND
and then also run on CLI:
heroku scale worker=1
For those that are passing both a port and a host, keep in mind that Heroku will not bind to localhost.
You must pass 0.0.0.0 for host.
Even if you're using the correct port. We had to make this adjustment:
# port (as described above) and host are both wrong
const host = 'localhost';
const port = 3000;
# use alternate localhost and the port Heroku assigns to $PORT
const host = '0.0.0.0';
const port = process.env.PORT || 3000;
Then you can start the server, as usual:
app.listen(port, host, function() {
console.log("Server started.......");
});
You can see more details here: https://help.heroku.com/P1AVPANS/why-is-my-node-js-app-crashing-with-an-r10-error
The error happens when Heroku failed to bind the port or hostname at server.listen(port, [host], [backlog], [callback]).
What Heroku requires is .listen(process.env.PORT) or .listen(process.env.PORT, '0.0.0.0')
So more generically, to support other environments, use this:
var server_port = process.env.YOUR_PORT || process.env.PORT || 80;
var server_host = process.env.YOUR_HOST || '0.0.0.0';
server.listen(server_port, server_host, function() {
console.log('Listening on port %d', server_port);
});
I had same issue while using yeoman's angular-fullstack generated project and removing the IP parameter worked for me.
I replaced this code
server.listen(config.port, config.ip, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
with
server.listen(config.port, function () {
console.log('Express server listening on %d, in %s mode', config.port, app.get('env'));
});
In my case, I was using example from https://hapijs.com/
To fix the problem I replaced
server.connection({
host: 'localhost',
port: 8000
});
with
server.connection({
port: process.env.PORT || 3000
});
change this line
app.listen(port);
to
app.listen(process.env.PORT, '0.0.0.0');
it will work
While most of the answers here are valid, for me the issue was that I was running long processes as part of npm run start which caused the timeout.
I found the solution here and to summarize it, I just had to move npm run build to a postinstall task.
In other words, I changed this:
"start": "npm run build && node server.js"
to this:
"postinstall": "npm run build",
"start": "node server.js"
Come to think of this, it totally makes sense because this error (which used to appear occasionally) was becoming more and more common as my app kept growing.
Changing my listening port from 3000 to (process.env.PORT || 5000) solved the problem.
Restarting all dynos in heroku did the trick for me
In my case, I was using Babel with the babel-plugin-transform-inline-environment-variables plugin. Apparently, Heroku does not set the PORT env variable when doing a deployment, so process.env.PORT will be replaced by undefined, and your code will fallback to the development port which Heroku does not know anything about.
I realized that I don't need the port number in the request endpoint, so the endpoint was herokuapp.com and not herokuapp.com:5000.
The listen() call can be without host and callback:
server.listen(5000);
I Use ReactJs,
If you want upload to heroku add this in your webpack.config.js
Because if not add you will have error
Error R10 (Boot timeout) -> Web process failed to bind to $PORT within
60 seconds of launch
//webpack.config.js add code like that
const HtmlWebPackPlugin = require("html-webpack-plugin");
const MiniCssExtractPlugin = require("mini-css-extract-plugin");
var server_port = process.env.YOUR_PORT || process.env.PORT || 5000;
var server_host = process.env.YOUR_HOST || "0.0.0.0";
module.exports = {
module: {
rules: [
{
test: /\.js$/,
exclude: /node_modules/,
use: {
loader: "babel-loader"
}
},
{
test: /\.css$/,
use: [MiniCssExtractPlugin.loader, "css-loader"]
}
]
},
devServer: {
disableHostCheck: true,
contentBase: "./ dist",
compress: true,
inline: true,
port: server_port,
host: server_host
},
plugins: [
new HtmlWebPackPlugin({
template: "./src/index.html",
filename: "index.html"
}),
new MiniCssExtractPlugin({
filename: "[name].css",
chunkFilename: "[id].css"
})
]
};
I had the same issue because I didn't define Procfile. Commit a text file to your app's root directory that is named Procfile without a file extension. This file tells Heroku which command(s) to run to start your app.
web: node app.js
Edit package.json:
...
"engines": {
"node": "5.0.0",
"npm": "4.6.1"
},
...
and Server.js:
...
var port = process.env.PORT || 3000;
app.listen(port, "0.0.0.0", function() {
console.log("Listening on Port 3000");
});
...
I've spent a lot of hours to find the root cause, and eventually I've found that this timeout (60s) can be adjustable. Here you may change 60 second to 120 or even more. It works for me, hope will help anybody else!
To resolve this follow these Four simple steps:
in the package.json file:
1- set the main field to the server file:
"main": "server.js" // <-- here set you server file
2- add the host parameter to the app.listen function
const port = process.env.PORT || 3000;
const host = '0.0.0.0'
app.listen(port, host, ()=> connsole.log(`server is running on port ${port}`)
3- add the postinstall script to package.json file
"scripts": {
"postinstall": "npm run build", // <-- add this line
"start": "node server.js" // <-- change server.js to you main file
}
4- add the engines field in package.json file
"engines": {
"node": ">=14.0.O", // <-- change it to your node version. you can "node -v" in you command line
"npm": ">=7.7.0" // <-- change this to your npm version. you can use "npm -v" in the command line to get your npm version
}
let me know if you have any succes with this!
Use process.env.PORT || 3000 for your port.
This will use Heroku's port when available or use port 3000 if it's not available (for example, local testing)
You can change 3000 to whatever you want, for example 8080
In your package.json file, in the scripts, make sure your start script contains -p $PORT.
Example of package.json (in this case, for NextJS app):
{
"private": true,
"scripts": {
"dev": "next dev -p 3001",
"build": "next build",
"start": "next start -p $PORT" // make sure to have -p $PORT in here
},
"dependencies": {
"typescript": "^4.3.2"
},
"devDependencies": {
"#next/eslint-plugin-next": "^11.1.2",
"#types/mongoose": "^5.11.97"
"typescript": "^4.3.2"
}
"license": "MIT"
}
I had same issue I could resolved issue with replace 'localhost' with IP which is '0.0.0.0'
In my case, neither the port nor the host was the problem. The index.js was divided into 2 files. server.js:
//server.js
const express = require('express')
const path = require('path')
const app = express()
app.use(express.static(path.resolve(__dirname, 'public')));
// and all the other stuff
module.exports = app
//app.js
const app = require('./server');
const port = process.env.PORT || 3000;
app.listen(port, '0.0.0.0', () => {
console.log('Server is running s on port: ' + port)
});
from package.json we ran node app.js.
Apparently that was the problem. Once I combined the two into one file, the Heroku app deployed as expected.
I have the same issue but my environment variables are set well and the version of npm and node is specified in package.json. I figured out it is because, in my case, Heroku needs "start" to be specified in package.json:
"scripts": {
"start": "node index.js"
}
After adding this to my package.json my node app is successfully deployed on Heroku.
While developing the application we need to define the PORT in the following way:
const port = process.env.PORT || 4000; // PORT must be in caps
And while deploying the app to server add the following method:
app.listen(port, () => {
console.info("Server started listening.");
});
We can pass hostname as second parameter while running it in local. But while deploying it to server the hostname parameter should be removed.
app.listen(port, hostName, () => {
console.info(`Server listening at http://${hostName}:${port}`);
});
My case was that I was running Database scripts on start up and were taking long time. I solved this by manually running npm start after deployment is complete.
A fixed number can't be set for port, heroku assigns it dynamically using process.env.PORT. But you can add them both, like this process.env.PORT || 5000. Heroku will use the first one, and your localhost will use the second one.
You can even add your call back function. Look at the code below
app.listen(process.env.PORT || 5000, function() {
console.log("Server started.......");
});
At of all the solution i have tried no one work as expected, i study heroku by default the .env File should maintain the convention PORT, the process.env.PORT, heroku by default will look for the Keyword PORT.
Cancel any renaming such as APP_PORT= instead use PORT= in your env file.
From the heroku bash process, pass down the value of $PORT to your node app using an options parser like yargs.
Here is an example of how you might do that. On the scripts object, inside package.json, add a start method "node server --port $PORT".
In your server file, use yargs to get the value from the port option (--port $PORT) of the start method:
const argv = require('yargs').argv;
const app = require('express')();
const port = argv.port || 8081;
app.listen(argv.port, ()=>{
console.log('Probably listening to heroku $PORT now ', argv.port); // unless $PORT is undefined, in which case you're listening to 8081.
});
Now when your app starts, it will bind to the dynamically set value of $PORT.
If, like me, you're configuring Heroku to run a script from your package.json file on deploy, make sure you haven't hard-coded the value of PORT in that script! If you do, you'll end up like me and spend an hour trying to figure out why you're getting this error.
I had same issue but with express and apollo-server. The solution from here:
The only special consideration that needs to be made is to allow
heroku to choose the port that the server is deployed to. Otherwise,
there may be errors, such as a request timeout.
To configure apollo-server to use a port defined by Heroku at runtime,
the listen function in your setup file can be called with a port
defined by the PORT environment variable:
> server.listen({ port: process.env.PORT || 4000 }).then(({ url }) => {
> console.log(`Server ready at ${url}`); });
In my case I had two issues...
1) no listener at all because of running app from another entry file and this run script was deleted from package.json "scripts"
2) Case sensitive problem with 'Sequelize' instead of 'sequelize'

Resources