Neo4j

Deploy Neo4j, a native graph database designed for storing and querying highly connected data. Neo4j uses the Cypher query language and is commonly used for relationship-driven workloads such as recommendation engines, fraud detection, and knowledge graph applications.

1. Deploy Neo4j

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:
- Use Shared CPU 4GB or Dedicated CPU 4GB, or larger for production workloads.
- For production deployments handling large graph datasets, analytics workloads, or high concurrency, use a Dedicated CPU plan for consistent performance and predictable resource allocation.

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: 1884304

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.
Email address (for the Let's Encrypt SSL certificate)	`soa_email_address`	The email address used for Let's Encrypt certificate notices when deploying with HTTPS enabled for Neo4j Browser or reverse proxy access.
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.
Linode API token	`token_password`	Applies 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.
Subdomain	`subdomain`	Applies to a custom domain. The subdomain you want to use, like `blog` or `blog.example.com`. Use it only if you specify a Domain.
Domain	`domain`	Applies to a custom domain. The domain name you want to use, like `example.com`. Use it only if you specify a Linode API token.
IP addresses allowed to access Neo4j UI	`neo4j_http_allow`	A comma-separated list of IP addresses allowed to connect to the Neo4j Browser UI.
IP addresses allowed to access Bolt	`neo4j_bolt_allow`	A comma-separated list of IP addresses allowed to connect over the Bolt protocol.
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

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.

If you don't allow your client IP address using neo4j_http_allow and neo4j_bolt_allow, you won't be able to access the Neo4j Browser UI until firewall rules are updated.

You can automatically configure a custom domain (optional) during deployment. To do that:

First, configure your domain to use Linode’s name servers via your registrar. See Configure your domain's authoritative name servers for details.

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-standard-2",
    "image": "linode/ubuntu24.04",
    "label": "my-neo4j-one-click-app",
    "root_pass": "@C0mpl3x#P@ssw0rd",
    "stackscript_id": 1884304,
    "stackscript_data": {
      "user_name": "jsmith",
      "soa_email_address": "jsmith@example.com"
    }
  }'

linode-cli linodes create \
  --region us-east \
  --type g6-standard-2 \
  --label my-neo4j-one-click-app \
  --image linode/ubuntu24.04 \
  --root_pass @C0mpl3x#P@ssw0rd \
  --stackscript_id 1884304 \
  --stackscript_data '{"user_name":"jsmith", "soa_email_address":"jsmith@example.com"}'

resource "linode_instance" "my-linode" {
  region         = "us-east"
  type           = "g6-standard-2"
  label          = "my-neo4j-one-click-app"
  image          = "linode/ubuntu24.04"
  root_pass      = "@C0mpl3x#P@ssw0rd"
  stackscript_id = 1884304
  stackscript_data = {
    "user_name"         = "jsmith"
    "soa_email_address" = "jsmith@example.com"
  }
}

2. Access Neo4j Browser

Open your web browser and navigate to https://[domain]:7473/browser, replacing [domain] with your custom domain entered during deployment or your Linode instance's rDNS value such as 192-0-2-1.ip.linodeusercontent.com.

See the Manage IP addresses on a Linode guide for information on viewing rDNS.
Log in using the username and password from the .credentials file.

Note: If you don't add your client IP to the allow list during deployment, you need to add it to the firewall to access the UI. You can use the UFW firewall guide to add your IP to the allow list.

Connect via Bolt

Neo4j uses the Bolt protocol for application and driver connections. On your Neo4j instance, cypher-shell is installed to interact with your Neo4j service.

You can test locally on the server with:

cypher-shell -a bolt://127.0.0.1:7687 -u [neo4j-user] -p [password]

Run a simple verification query after logging in through Neo4j Browser or cypher-shell:

SHOW DATABASES;

This query returns all databases and confirms that your Neo4j instance is operational.

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.