JSOPanel Get started
Help Center › Website Owners › Installing a Node.js application

Installing a Node.js application

Upload and run your own Node.js application, kept running automatically.

If you have your own Node.js application (a custom-built web app or API written in JavaScript), JSOPanel can host it and keep it running continuously, restarting it automatically if it ever stops unexpectedly. Each application runs under its own service and is reached through your domain, it never listens on a public port directly.

Steps

  1. Click Node.js Apps under Applications in the sidebar.
  2. Under Create an app, enter a name for the app.
  3. Choose which domain the application should be reached through.
  4. Choose the Node.js version your application needs, from the versions your provider has made available.
  5. Enter the App folder your application's files live in (its package.json and node_modules); leave it as nodeapp if you're starting a new one.
  6. Enter either an Entry point (the file to run with node, such as server.js), or a Start script naming a script from your package.json to run with npm run, such as start, for something like Next.js or Nuxt.
  7. Leave Port empty unless your application has a specific port written into its own code, in which case enter that number. A free port is chosen for you either way; nothing outside your server reaches it directly, since visitors always arrive through your domain.
  8. Decide whether to tick Serve the domain from this app: leave it ticked to have visitors to the domain reach the app immediately, or untick it to keep the site's existing files on the web while you test the app first.
  9. Click Create app.

Uploading your application files

Once the app entry is created, upload your application's files into its app folder using the file manager or FTP (see the articles on using the file manager and connecting with FTP), including everything it needs to run, such as its dependencies. If your application needs a build step (as many Next.js, Nuxt, or similar frameworks do), run that build first from a terminal or over SSH before starting the app, since JSOPanel only runs what you give it.

Starting and managing your application

Each app you've created is listed with its status. From here you can:

  • Click start, stop, or restart
  • Click Log to see the last 200 lines of what the application has printed, useful when something isn't working and the reason is in its own output
  • Click Serve the domain from this app or Take off the domain to switch whether visitors reach this app or your domain's own files
  • Click Edit to change the app's name, domain, port, entry point, start script, folder, or Node.js version without losing its registration or having to recreate it
  • Click Remove to remove the app's service; your code is left in place on disk
Tip: once started, your application is kept running automatically going forward, including coming back on its own if the server restarts. You don't need to start it again yourself after routine maintenance. If an app is stopped while it's still set to serve a domain, that domain goes down until you start the app again or take it off the domain, since there's no other page for visitors to fall back to. The start and stop buttons grey themselves out once pressing them wouldn't change anything, so it's always clear at a glance which one is live.

If your application connects to a database, create one from the Databases page and enter its connection details into your application's own configuration, the same way you would for any other database-backed application.

If you uploaded an application's files directly without registering it here first, JSOPanel checks for one automatically every time you open the Node.js Apps page. If it finds something, an Applications found on disk card appears on its own, letting you register it from there, there's no button to press to trigger the check.