OpenLiteSpeed Node.js

Deploy Node.js with OpenLiteSpeed, an open-source web server with HTTP/3 support.

This app installs OpenLiteSpeed, Node.js, TLS support, and a sample application.

1. Deploy OpenLiteSpeed Node.js

 Estimated deployment time: 10–15 minutes

Follow the deployment instructions from the Get started section to configure the app, deploy it, and verify software installation.

For information on the app-specific configurations, see the Configuration options section.

Base distribution and plan

  • Supported distribution: Ubuntu 24.04 LTS
  • Recommended plans: All plan types and sizes can be used.

Configuration options

Configure the required options to deploy your instance. For additional customization, add advanced options.

The table maps the Cloud Manager UI fields to their corresponding API/CLI keys (stackscript_data) required for automated deployments.

StackScript ID: 923031

UI fieldAPI/CLI keyDescription
Required options
Limited sudo useruser_nameYour preferred username for the limited sudo user entered without any capital letters, spaces, or special characters.
When adding a limited sudo user, the user is created with a strong generated password for your new Linode instance, and the account is assigned to the sudo group, which provides elevated permissions when running commands with the sudo prefix.
Note: For easier and more secure access with the sudo user, add an account SSH key for the Cloud Manager user during deployment and select that user as an authorized_user. Their SSH pubkey will be assigned to both the root and limited user.
Email address (for the Let's Encrypt SSL certificate)soa_email_addressThe email address used for generating SSL certificates.
Advanced options
Disable root access over SSHdisable_rootApplies to a limited sudo user. To block the root user from logging in over SSH, select Yes. Defaults to No.
Note: When you disable the root user from logging in over SSH and don't provide a valid account SSH key assigned to the authorized_user, you can still switch to the root user. To do that, log in as root via the Lish console and run cat /home/$USERNAME/.credentials to view the generated password for the limited sudo user.
Linode API tokentoken_passwordApplies to a custom domain. The Linode API token if you want to use Linode's DNS Manager to manage DNS records for your custom domain. Follow Manage personal access tokens to get your token on your account with Read/Write access to Domains.
  • If you provide the token along with the subdomain and domain, the installation attempts to create DNS records via the Linode API.
  • If you don't provide the token, you need to manually configure your DNS records through your DNS provider and point them to the IP address of the new instance.
SubdomainsubdomainApplies to a custom domain. The subdomain you want to use, like blog for blog.example.com. Use it only if you specify a Domain.
DomaindomainApplies to a custom domain. The domain name you want to use, like example.com. Use it only if you specify a Linode API token.
Optional data exporter Add-onsadd_onsAn option to include add-ons for your deployment. Possible values are:
  • none (default)
  • alloy
  • newrelic
  • node_exporter
  • mysqld_exporter
  • opentelemetry_collector

Notes:

  • After the app deployment completes, the password for your limited sudo user is generated and stored in the .credentials file in the home directory, along with application-specific passwords. Log in to your instance as root through the Lish console or SSH, then run cat /home/$USERNAME/.credentials to view its contents.
  • You can automatically configure a custom domain (optional) during deployment. To do that:
    1. Configure your domain to use Linode's name servers via your registrar. See Configure your domain's authoritative name servers for details.
    2. Once you complete that, specify the Linode API token, subdomain, and domain for the app in Cloud Manager or via API/CLI/Terraform.

Use API, CLI, or Terraform

In addition to deploying the app to a new Linode instance via Cloud Manager, you can also use the Linode API, CLI, or Terraform. When running the operation, you need to provide the StackScript ID, supported Linux distribution, and app-specific fields along with the standard Linode deployment configurations.

Note: Generate a personal access token to authenticate your API, CLI, or Terraform requests.

curl --location 'https://api.linode.com/v4/linode/instances' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer abc123def456hij789klm' \
  --data-raw '{
    "region": "us-east",
    "type": "g6-dedicated-4",
    "image": "linode/ubuntu24.04",
    "label": "my-openlitespeed-nodejs-app",
    "root_pass": "@C0mpl3x#P@ssw0rd",
    "stackscript_id": 923031,
    "stackscript_data": {
      "user_name": "jsmith",
      "soa_email_address": "jsmith@example.com"
    }
  }'
linode-cli linodes create \
  --region us-east --type g6-dedicated-4 \
  --label my-openlitespeed-nodejs-app --image linode/ubuntu24.04 \
  --root_pass @C0mpl3x#P@ssw0rd --stackscript_id 923031 \
  --stackscript_data '{"user_name":"jsmith", "soa_email_address":"jsmith@example.com"}'
resource "linode_instance" "my-linode" {
  region         = "us-east"
  type           = "g6-dedicated-4"
  label          = "my-openlitespeed-nodejs-app"
  image          = "linode/ubuntu24.04"
  root_pass      = "@C0mpl3x#P@ssw0rd"
  stackscript_id = 923031
  stackscript_data = {
    "user_name"         = "jsmith"
    "soa_email_address" = "jsmith@example.com"
  }
}

2. Access the OpenLiteSpeed Node.js app

  1. Log in to your instance over SSH, using the sudo user created during deployment or root. You should see the message of the day (MOTD), which provides server information, including access details, useful links, and system status.

    Welcome to One-Click OpenLiteSpeed Node.js Server.
    To keep this Droplet secure, the firewalld is enabled.
    All ports are BLOCKED except 22 (SSH), 80 (HTTP), and 443 (HTTPS).
    
    The Node.js OLS One-Click Quickstart guide:
    * https://docs.litespeedtech.com/cloud/images/nodejs/
    
    In a web browser, you can view:
    * The sample node site: http://23.239.26.100/
    
    On the server:
    * You can get the Web admin password with the following command:
       sudo cat .litespeed_password
    
    System Status:
    Load : 0.10, 0.60, 0.43
    CPU  : 66.3045%
    RAM  : 147/1987MB (7.40%)
    Disk : 3/49GB (7%)
  2. You're then prompted to enter the domain you’d like to use for this instance.

    You can optionally use a custom domain you’ve already configured with the A records pointing to this server’s IPv4 and IPv6 addresses. Otherwise, you can skip this by pressing CTRL+C, and the system will use your instance's IP address or default rDNS.

Now that you’ve accessed your OpenLiteSpeed Node.js instance, you can further configure it.

Additional resources

For more information about the installed packages, see their official documentation.

📘

Note that we can't vouch for the accuracy or timeliness of externally hosted resources.


Did this page help you?