How to deploy a nextjs application on cpanel?

Deploying Next.js projects on cPanel can be a complex process since Next.js is primarily designed for Node.js environments, while cPanel is mainly used for managing PHP applications. However, with the right techniques and tools, deployment is achievable. Below are the general steps to deploy a Next.js project to cPanel:

1. Confirm cPanel Supports Node.js

First, confirm that your hosting provider supports Node.js applications within cPanel. Not all cPanel configurations include built-in Node.js support, so this is crucial.

2. Prepare the Next.js Application

Ensure your Next.js application runs correctly in your local environment. Then run next build to generate the production version. This will create a .next folder in your project containing compiled code and assets.

3. Upload the Project to cPanel

Upload your Next.js project to the server using FTP or cPanel's file manager, including all source files, the .next folder, package.json, and any other necessary files.

4. Configure the Node.js Environment

Locate the 'Software' or 'Software/Services' section in cPanel and click 'Setup Node.js App'. Here, create a Node.js application instance. Select the appropriate Node.js version (ensuring compatibility with your local development environment) and set the application's root directory and startup file (typically server.js or app.js, depending on how you configured Next.js with a custom server).

5. Install Dependencies and Start the Application

On the Node.js application page in cPanel, you'll see a terminal or command input interface. Run npm install or yarn to install your project's dependencies. After installation, run npm run start or yarn start to launch your Next.js application.

6. Configure a Reverse Proxy (if necessary)

If your Next.js application needs to run on a specific port, you may need to set up a reverse proxy in cPanel to access it externally correctly. This typically involves editing the .htaccess file to redirect traffic from public ports (such as 80 or 443) to your application's port.

Example: Assume you have a Next.js application with a simple page. After running next build, upload your project to cPanel and follow the above steps to configure the Node.js environment and dependencies. In the server.js file, you might have similar code to start the Next.js server:

javascript
const next = require('next');
const express = require('express');
const dev = process.env.NODE_ENV !== 'production';
const app = next({ dev });
const handle = app.getRequestHandler();

app.prepare().then(() => {
  const server = express();

  server.get('*', (req, res) => {
    return handle(req, res);
  });

  server.listen(3000, (err) => {
    if (err) throw err;
    console.log('> Ready on http://localhost:3000');
  });
});

This is a basic setup; you may need to adjust and optimize based on your specific situation.

Conclusion Deploying Next.js to cPanel is possible, but ensure the cPanel environment supports Node.js and may require additional configuration. This process can be more complex than deploying on platforms specifically designed for Node.js (such as Vercel or Heroku). If you frequently deploy JavaScript or Node.js applications, consider using a hosting solution better suited for these technologies.