NetFoundry Edge Router

Deploy a NetFoundry Edge Router, a lightweight, software-based gateway that provides secure, zero-trust networking between endpoints, cloud environments, and private networks. It acts as a bridge between local networks and the NetFoundry overlay network.

1. Deploy NetFoundry Edge Router

Estimated deployment time: 3–5 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: 1785544

UI field	API/CLI key	Description
Required options
Limited sudo user	`user_name`	Your 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.
Advanced options
Disable root access over SSH	`disable_root`	Applies 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.
EdgeRouter registration key	`registration_key`	The registration key generated when creating the Edge Router in your NetFoundry account. To get the key, create a NetFoundry account.
Optional data exporter Add-ons	`add_ons`	An option to include add-ons for your deployment. Possible values are: none (default) newrelic node_exporter mysqld_exporter

Note: 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.

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-netfoundry-router-one-click-app",
    "root_pass": "@C0mpl3x#P@ssw0rd",
    "stackscript_id": 1785544,
    "stackscript_data": {
      "user_name": "jsmith"
    }
  }'

linode-cli linodes create \
  --region us-east \
  --type g6-dedicated-4 \
  --label my-netfoundry-router-one-click-app \
  --image linode/ubuntu24.04 \
  --root_pass @C0mpl3x#P@ssw0rd \
  --stackscript_id 1785544 \
  --stackscript_data '{"user_name":"jsmith"}'

resource "linode_instance" "my-linode" {
  region         = "us-east"
  type           = "g6-dedicated-4"
  label          = "my-netfoundry-router-one-click-app"
  image          = "linode/ubuntu24.04"
  root_pass      = "@C0mpl3x#P@ssw0rd"
  stackscript_id = 1785544
  stackscript_data = {
    "user_name" = "jsmith"
  }
}

2. Access the NetFoundry console

This app requires an active NetFoundry account to create and manage endpoints and edge routers.

If you don’t have an account, you need to create it to fully use this app.

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.