|
| 1 | +--- |
| 2 | +title: "Deploy Neo4j" |
| 3 | +description: "This guide includes instructions on how to deploy Neo4j, a leading graph database platform, on an Akamai Compute Instance." |
| 4 | +published: 2026-02-23 |
| 5 | +modified: 2026-02-23 |
| 6 | +keywords: ['neo4j', 'graph-database', 'cypher', 'bolt', 'graph-analytics', 'database', 'graph'] |
| 7 | +tags: ["quick deploy apps", "linode platform", "cloud manager", "database", "graph-database"] |
| 8 | +aliases: ['/products/tools/marketplace/guides/neo4j/'] |
| 9 | +external_resources: |
| 10 | +- '[Neo4j Documentation](https://neo4j.com/docs/)' |
| 11 | +- '[Cypher Query Language Manual](https://neo4j.com/docs/cypher-manual/current/)' |
| 12 | +- '[Neo4j Operations Manual](https://neo4j.com/docs/operations-manual/current/)' |
| 13 | +authors: ["Akamai"] |
| 14 | +contributors: ["Akamai"] |
| 15 | +license: '[CC BY-ND 4.0](https://creativecommons.org/licenses/by-nd/4.0)' |
| 16 | +marketplace_app_id: 1884304 |
| 17 | +marketplace_app_name: "Neo4j" |
| 18 | +--- |
| 19 | + |
| 20 | +Neo4j is a high-performance, native graph database designed to store, manage, and query highly connected data. Using the Cypher query language, Neo4j enables developers to model complex relationships and traverse large datasets efficiently. |
| 21 | + |
| 22 | +Neo4j is widely used for applications such as fraud detection, knowledge graphs, recommendation engines, identity and access management, network analysis, and AI-driven data exploration. Its native graph storage engine and ACID-compliant transactions make it suitable for both development and production workloads. |
| 23 | + |
| 24 | +## Deploying a Quick Deploy App |
| 25 | + |
| 26 | +{{% content "deploy-marketplace-apps-shortguide" %}} |
| 27 | + |
| 28 | +{{% content "marketplace-verify-standard-shortguide" %}} |
| 29 | + |
| 30 | +{{< note title="Estimated deployment time" >}} |
| 31 | +Neo4j should be fully installed within 3-5 minutes after the Compute Instance has finished provisioning. |
| 32 | +{{< /note >}} |
| 33 | + |
| 34 | +## Configuration Options |
| 35 | + |
| 36 | +- **Recommended plan:** Shared CPU 4GB or Dedicated CPU 4GB (or larger for production workloads) |
| 37 | + |
| 38 | +{{< note type="warning" >}} |
| 39 | +For production deployments handling large graph datasets, analytics workloads, or high concurrency, we strongly recommend using a Dedicated CPU plan to ensure consistent performance and predictable resource allocation. |
| 40 | +{{< /note >}} |
| 41 | + |
| 42 | +### Neo4j Options |
| 43 | + |
| 44 | +- **IP Address Allowed to Access Neo4j UI** *(recommended)*: Any IP that needs to access the Neo4j UI can be added to the firewall. *Please note* If you do not add an IP to this field, the UI will not be exposed. Firewall rules can be added later to allow access to the UI |
| 45 | +- **IP addresses allowed to access Bolt** *(recommended)*: Any IP that needs Bolt access can be added to the firewall. *Please note* If you do not add an IP to this field. Firewall rules can be added later to allow access to the UI. |
| 46 | +- **Email address (for the Let's Encrypt SSL certificate)** *(optional)*: If deploying with HTTPS enabled for Neo4j Browser or reverse proxy access, this email is used for Let's Encrypt renewal notices. |
| 47 | + |
| 48 | +{{% content "marketplace-required-limited-user-fields-shortguide" %}} |
| 49 | + |
| 50 | +{{% content "marketplace-special-character-limitations-shortguide" %}} |
| 51 | + |
| 52 | +## Getting Started After Deployment |
| 53 | + |
| 54 | +### Obtain the Credentials |
| 55 | + |
| 56 | +When deployment completes, the system automatically generates and stores credentials for administering your Neo4j instance. These credentials are stored in the limited user’s `.credentials` file. |
| 57 | + |
| 58 | +1. Log in to your Compute Instance using one of the methods below: |
| 59 | + |
| 60 | + - **Lish Console**: Log in to Cloud Manager, click **Linodes**, select your instance, and click **Launch LISH Console**. Log in as `root`. To learn more, see [Using the Lish Console](/docs/products/compute/compute-instances/guides/lish/). |
| 61 | + - **SSH**: Log in to your instance over SSH using the `root` user. To learn how, see [Connecting to a Remote Server Over SSH](/docs/guides/connect-to-server-over-ssh/). |
| 62 | + |
| 63 | +2. Run the following command to access the contents of the `.credentials` file: |
| 64 | + |
| 65 | +```command |
| 66 | +cat /home/$USERNAME/.credentials |
| 67 | +``` |
| 68 | +### Accessing Neo4j Browser |
| 69 | + |
| 70 | +Once your app has finished deploying, you can log into Neo4j UI using your browser. |
| 71 | + |
| 72 | +1. Open your web browser and navigate to `https://$DOMAIN$:7473/browser`, where *DOMAIN* can be replaced with the custom domain you entered during deployment or your Compute Instance's rDNS domain (such as `192-0-2-1.ip.linodeusercontent.com`). See the [Managing IP Addresses](/docs/products/compute/compute-instances/guides/manage-ip-addresses/) guide for information on viewing rDNS. |
| 73 | + |
| 74 | +**Please Note** If you did not add your local IP to the allow list at the beginning of the deployment, you will need to add it to the firewall in order to access the UI. You can utilize [UFW firewall guide](/docs/guides/configure-firewall-with-ufw/) to add your IP to the allow list. |
| 75 | + |
| 76 | +Log in using the credentials from the `/home/$USERNAME/.credentialsoffic` file. |
| 77 | + |
| 78 | +## Connecting via Bolt |
| 79 | + |
| 80 | +Neo4j uses the Bolt protocol for application and driver connections. |
| 81 | + |
| 82 | +## Example: Using cypher-shell on the Server |
| 83 | + |
| 84 | +On your Neo4j instance `cypher-shell` is installed to interact with your neo4j service. You can use the following example to connect to your neo4j database: |
| 85 | + |
| 86 | + |
| 87 | + cypher-shell -a bolt://127.0.0.1:7687 -u NEO4J_USER -p YOUR_PASSWORD |
| 88 | + |
| 89 | + |
| 90 | +## Basic Verification Query |
| 91 | + |
| 92 | +After logging in through Neo4j Browser or `cypher-shell`, run: |
| 93 | + |
| 94 | + SHOW DATABASES; |
| 95 | + |
| 96 | +This query will return all databases, and confirms that your Neo4j instance is operational. Now that you’ve accessed your instance, check out [the official Neo4j documentation](https://neo4j.com/docs/) to learn how to further use your instance. |
| 97 | + |
| 98 | +{{% content "marketplace-update-note-shortguide" %}} |
0 commit comments