Debian - Operations Manual
Docs
Docs
Neo4j DBMS
Getting Started
Operations
Migration and Upgrade
Status Codes
Java Developer Reference
Kerberos Add-on
Neo4j Aura
Neo4j Aura
Neo4j AuraDB
Neo4j AuraDS
Neo4j Tools
Neo4j Bloom
Neo4j Browser
Neo4j Desktop
Neo4j Ops Manager
Neo4j Graph Data Science
Neo4j Graph Data Science Library
Cypher Query Language
Cypher
Cypher Cheat Sheet
APOC Library
Neo4j Drivers and APIs
Go Driver
Java Driver
JavaScript Driver
.Net Driver
Python Driver
Neo4j GraphQL Library
HTTP API
OGM Library
Spring Data Neo4j
Neo4j Connector for Apache Spark
Neo4j Connector for Apache Kafka
Labs
arrows.app
Details
arrows.app
APOC
Documentation
Developer Guide
GraphQL & GRANDStack
Details
GRANDstack.io
Halin
Kafka Integration
Details
Documentation
ETL Tool
Details
Documentation
Neo4j Plugin For Liquibase
Details
Documentation
Neosemantics
Getting Started
Documentation
Neo4j Helm
Details
Documentation
NeoDash
Details
Documentation
Get Help
GraphAcademy
Free, Self Paced Training
Certification
Community Forum
Discord Chat
Knowledge Base
Neo4j Developer Blog
Neo4j Videos
Get Started
Neo4j AuraDB Start Free
Start your fully managed Neo4j cloud database
Neo4j Sandbox
Learn and use Neo4j for data science & more
Neo4j Desktop
Manage multiple local or remote Neo4j projects
Search
Neo4j Version
Operations Manual 5
4.4
4.3
4.2
4.1
4.0
3.5
The Neo4j Operations Manual v5
Introduction
Installation
System requirements
Neo4j Browser
Neo4j Desktop
Linux installation
Debian
Deploy Neo4j using the Neo4j RPM package
Linux tarball installation
Neo4j system service
macOS installation
Windows installation
Cloud deployments
Neo4j on AWS
Neo4j on Google Cloud Platform
Neo4j standalone instance (VM-based)
Clusters (VM-based)
Neo4j deployments automation on Google Cloud Platform (GCP)
Neo4j on Azure
Docker
Introduction
Configuration
Deploy a Neo4j cluster on Docker
Docker-specific operations
SSL encryption in a Neo4j Docker container
Docker maintenance operations
Docker-specific configuration settings
Kubernetes
Introduction
Configure the Neo4j Helm chart repository
Quickstart: Deploy a standalone instance
Neo4j Helm chart for standalone server deployments
Prerequisites
Create a Helm deployment values.yaml file
Install a Neo4j standalone instance
Verify the installation
Uninstall Neo4j and clean up the created resources
Quickstart: Deploy a cluster
Neo4j Helm chart for cluster deployments
Prerequisites
Create Helm deployment values files
Install Neo4j cluster servers
Verify the Neo4j cluster formation
Access the Neo4j cluster from inside Kubernetes
Access the Neo4j cluster from outside Kubernetes
Uninstall the Neo4j cluster and clean up the created resources
Configure a Neo4j Helm deployment
Volume mounts and persistent volumes with the Neo4j Helm chart
Access a Neo4j standalone server
Access a Neo4j cluster
Import Data
Monitoring
Operations
Deploy a multi-data center Neo4j cluster
Deploy a single Neo4j cluster across multiple AKS clusters
Troubleshooting
Configuration
The neo4j.conf file
Default file locations
Ports
Configure connectors
Set an initial password
Password and user recovery
Update dynamic settings
Transaction log
Manage databases
Introduction
Administration and configuration
Queries
Error handling
Connecting remote databases
Composite databases
Introduction
Querying
Sharding data with the copy command
Further considerations
Clustering
Introduction
Set up a cluster
Deploy a basic cluster
Cluster server discovery
Leadership, routing and load balancing
Intra-cluster encryption
Managing servers in a cluster
Managing databases in a cluster
Monitoring
Monitor servers
Monitor databases
Disaster recovery
Settings reference
Clustering glossary
Backup and restore
Backup and restore planning
Backup modes
Back up an online database
Aggregate a database backup chain
Restore a database backup
Back up an offline database
Restore a database dump
Copy a database store
Authentication and authorization
Introduction
Built-in roles
Fine-grained access control
Integration with LDAP directory services
Integration with Single Sign-On Services
Manage procedure and user-defined function permissions
Terminology
Security
Securing extensions
SSL framework
Browser credentials handling
Security checklist
Performance
Memory configuration
Index configuration
Tuning of the garbage collector
Bolt thread pool configuration
Linux file system tuning
Locks and deadlocks
Disks, RAM and other tips
Statistics and execution plans
Space reuse
Monitoring
Logging
Metrics
Essential metrics
Enable metrics logging
Expose metrics
Metrics reference
Manage queries
Manage transactions
Manage connections
Manage background jobs
Tools
Neo4j Admin and Neo4j CLI
Consistency checker
Neo4j Admin report
Display store information
Memory recommendations
Import
Unbind a Neo4j cluster server
Upload to Neo4j Aura
Migrate a database
Migrate the Neo4j configuration file
Cypher Shell
Appendix
Reference
Configuration settings
Dynamic configuration settings
Procedures
Tutorials
Neo4j-admin import
Set up and use a composite database
Neo4j Single Sign-On (SSO) configuration
Administering immutable privileges
Operations Manual
Installation
Linux installation
Debian
Debian
You can install Neo4j on Debian, and Debian-based distributions like Ubuntu, using the Neo4j Debian package.
Java prerequisites
Neo4j 5 requires the Java 17 runtime.
Java 17 is not included in Ubuntu 16.04 LTS and will have to be set up manually prior to installing or upgrading to Neo4j 5, as described below.
Debian 11 and Ubuntu 18.04 onwards already have the OpenJDK Java 17 package available through apt.
Oracle JDK, Zulu JDK, or Corretto JDK
If you wish to use a non-default JDK, it must be installed prior to starting the Neo4j installation.
Otherwise, your package manager will install the default java distribution for your operating system, usually OpenJDK.
Download and installation instructions can be found on the manufacturer’s website:
Oracle JDK
Zulu JDK
Amazon Corretto JDK
OpenJDK 17 on Ubuntu 16.04
Add the official OpenJDK package repository to apt:
sudo add-apt-repository -y ppa:openjdk-r/ppa
sudo apt-get update
You are now ready to install Neo4j, which will install Java 17 automatically if it is not already installed.
See Dealing with multiple installed Java versions to make sure you can start Neo4j after install.
Dealing with multiple installed Java versions
It is important that you configure your default Java version to point to Java 17, or Neo4j 5.3.0 will be unable to start.
Do so with the update-java-alternatives command.
First list all your installed versions of Java with update-java-alternatives --list
Your results may vary, but this is an example of the output:
java-1.17.0-openjdk-amd64 1711 /usr/lib/jvm/java-1.17.0-openjdk-amd64
java-1.11.0-openjdk-amd64 1071 /usr/lib/jvm/java-1.11.0-openjdk-amd64
Identify your Java 17 version, in this case, it is java-1.17.0-openjdk-amd64.
Then set it as the default with (replacing <java17name> with the appropriate name from above):
sudo update-java-alternatives --jre --set <java17name>
Finally, confirm which version of Java is the default:
java -version
Installation
Add the repository
The Debian package is available from https://debian.neo4j.com.
To use the repository for generally available versions of Neo4j, run:
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
echo 'deb https://debian.neo4j.com stable latest' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
sudo apt-get update
To avoid the risk of the apt package manager accidentally forcing a database upgrade, different major and minor releases of Neo4j are also available separately inside the repository.
To install Neo4j this way, specify the major and minor version required, in place of latest.
The following method for production or business-critical installations is recommended:
wget -O - https://debian.neo4j.com/neotechnology.gpg.key | sudo apt-key add -
echo 'deb https://debian.neo4j.com stable 5' | sudo tee -a /etc/apt/sources.list.d/neo4j.list
sudo apt-get update
Once the repository has been added into apt, you can verify which Neo4j versions are available by running:
apt list -a neo4j
In Ubuntu server installations you will also need to make sure that the universe repository is enabled.
If the universe repository is not present, the Neo4j installation will fail with the error Depends: daemon but it is not installable.
This can be fixed by running the command:
sudo add-apt-repository universe
Install Neo4j
To install Neo4j Community Edition:
sudo apt-get install neo4j=1:5.3.0
To install Neo4j Enterprise Edition:
sudo apt-get install neo4j-enterprise=1:5.3.0
Note that the version includes an epoch version component (1:), in accordance with the Debian policy on versioning.
When installing Neo4j Enterprise Edition, you will be prompted to accept the license agreement.
Once the license agreement is accepted installation begins.
Your answer to the license agreement prompt will be remembered for future installations on the same system.
To forget the stored answer, and trigger the license agreement prompt on subsequent installation, use debconf-communicate to purge the stored answer:
echo purge | sudo debconf-communicate neo4j-enterprise
Non-interactive installation of Neo4j Enterprise Edition
For Neo4j Enterprise Edition, the license agreement is presented in an interactive prompt.
If you require non-interactive installation of Neo4j Enterprise Edition, you can indicate that you have read and accepted the license agreement using debconf-set-selections:
echo "neo4j-enterprise neo4j/question select I ACCEPT" | sudo debconf-set-selections
echo "neo4j-enterprise neo4j/license note" | sudo debconf-set-selections
Offline installation
If you cannot reach https://debian.neo4j.com, perhaps due to a firewall, you need to obtain Neo4j via an alternative machine that has the relevant access, and then move the package manually.
It is important to note that using this method will mean that the offline machine will not receive the dependencies that are normally downloaded and installed automatically when using apt for installing Neo4j; Cypher Shell and Java (if not installed already):
The Cypher Shell package can be downloaded from /download-center[Neo4j Download Center].
For information on supported versions of Java, see System requirements.
Run the following to download the required Debian software package:
Neo4j Enterprise Edition:
curl -O https://dist.neo4j.org/deb/neo4j-enterprise_5.3.0_all.deb
To list all files that the Debian software package (.deb file) installs:
dpkg --contents neo4j_5.3.0_all.deb
Neo4j Community Edition:
curl -O https://dist.neo4j.org/deb/neo4j_5.3.0_all.deb
Manually move the downloaded Debian package to the offline machine.
Run the following on the offline machine to install Neo4j:
sudo dpkg -i <deb file name>
File locations
File locations for all Neo4j packages are documented here.
Operation
Most Neo4j configuration goes into neo4j.conf.
For operating systems using systemd, some package-specific options are set in neo4j.service and can be edited using systemctl edit neo4j.service.
For operating systems that are not using systemd, some package-specific options are set in /etc/default/neo4j.
Environment variable
Default value
Details
NEO4J_SHUTDOWN_TIMEOUT
120
Timeout in seconds when waiting for Neo4j to stop. If it takes longer than this then the shutdown is considered to have failed. This may need to be increased if the system serves long-running transactions.
NEO4J_ULIMIT_NOFILE
60000
Maximum number of file handles that can be opened by the Neo4j process.
Linux installation
Deploy Neo4j using the Neo4j RPM package
Was this page helpful?
© 2022 Neo4j, Inc.
Terms | Privacy | Sitemap
Neo4j®, Neo Technology®, Cypher®, Neo4j® Bloom™ and
Neo4j® Aura™ are registered trademarks
of Neo4j, Inc. All other marks are owned by their respective companies.
Contact Us →
US: 1-855-636-4532
Sweden +46 171 480 113
UK: +44 20 3868 3223
France: +33 (0) 8 05 08 03 44
Learn
Sandbox
Neo4j Community Site
Neo4j Developer Blog
Neo4j Videos
GraphAcademy
Neo4j Labs
Social
Twitter
Meetups
Github
Stack Overflow
Want to Speak? Get $ back.