Neo4j Operations manual Docs
Docs
Neo4j DBMS
  • Getting Started
  • Operations
  • Migration and Upgrade
  • Status Codes
  • Java Reference
  • Kerberos Add-on
Neo4j Aura
  • Neo4j Aura
  • Neo4j AuraDB
  • Neo4j AuraDS
Neo4j Tools
  • Neo4j Bloom
  • Neo4j Browser
  • Neo4j Data Importer
  • Neo4j Desktop
  • Neo4j Ops Manager
  • Neodash commercial
Neo4j Graph Data Science
  • Neo4j Graph Data Science Library
  • Neo4j Graph Data Science Client
Cypher Query Language
  • Cypher
  • Cypher Cheat Sheet
  • APOC Library
Generative AI
  • Neo4j GraphRAG for Python
  • Embeddings and vector indexes tutorial
  • GenAI integrations
  • Vector search indexes
  • Vector search functions
  • GraphQL vector index search documentation
Create applications
  • Python Driver
  • Go Driver
  • Java Driver
  • JDBC Driver
  • JavaScript Driver
  • .Net Driver
  • Neo4j GraphQL Library
  • Neo4j Visualization Library
  • OGM Library
  • Spring Data Neo4j
  • HTTP API
  • Neo4j Query API
  • Bolt
Connect data sources
  • Neo4j Connector for Apache Spark
  • Neo4j Connector for Apache Kafka
  • Change Data Capture (CDC)
  • BigQuery to Neo4j
  • Google Cloud to Neo4j
Labs
GenAI Ecosystem
  • LLM Knowledge Graph Builder
  • Vector Index & Search
  • LangChain
  • LangChain.js
  • LlamaIndex
  • Haystack
  • DSPy
Developer Tools
  • APOC Extended
  • Aura CLI
  • arrows.app
  • Cypher Workbench
  • ETL Tool
  • NeoDash
Frameworks & Integrations
  • Needle Starter Kit
  • Neo4j Plugin for Liquibase
  • Neo4j Migrations
  • neomodel
RDF & Linked Data
  • Neosemantics (Java)
  • RDFLib-Neo4j (Python)
Get Help
Community Forum
Discord Chat
Product Support
Neo4j Developer Blog
Neo4j Videos
GraphAcademy
Beginners Courses
  • Neo4j Fundamentals
  • Cypher Fundamentals
  • Importing Data Fundamentals
  • Importing CSV Data
  • Graph Data Modeling
Data Scientist Courses
  • Into to Graph Data Science
  • Graph Data Science Fundamentals
  • Path Finding
Generative AI Courses
  • Neo4j & LLM Fundamentals
  • Vector Indexes & Unstructured Data
  • Build a Chatbot with Python
  • Build a Chatbot with TypeScript
Neo4j Certification
  • Neo4j Certified Professional
  • Neo4j Graph Data Science Certification
Get Started Free
Search
Skip to content
Operations Manual
Product Version
    • The Neo4j Operations Manual
    • Introduction
    • Installation
      • System requirements
      • Linux installation
        • Debian-based distributions (.deb)
        • Red Hat, CentOS, Fedora, and Amazon Linux (.rpm)
        • Linux executable (.tar)
        • Neo4j system service
      • macOS installation
      • Windows installation
      • Neo4j Desktop
    • Cloud deployments
      • Neo4j on AWS
      • Neo4j on GCP
      • Neo4j on Azure
    • Docker
      • Getting started with Neo4j in Docker
      • Persisting data with Docker volumes
      • Modify the default configuration
      • Plugins
      • Deploy a Neo4j standalone server using Docker Compose
      • Deploy a Neo4j cluster on multiple Docker hosts
      • Docker-specific operations
      • Dump and load a Neo4j database (offline)
      • Back up and restore a Neo4j database (online)
      • SSL encryption in a Neo4j Docker container
      • Docker-specific configuration settings
    • Kubernetes
      • Introduction
      • Configuring 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 Neo4j cluster and clean up resources
      • Quickstart: Deploy a Neo4j cluster for analytic queries
      • Volume mounts and persistent volumes
      • Customizing a Neo4j Helm chart
      • Configuring SSL
      • Authentication and authorization
      • Plugins
      • Accessing Neo4j
      • Accessing Neo4j using Kubernetes Ingress
      • Importing data
      • Monitoring
      • Operations
        • Maintenance modes
        • Reset the neo4j user password
        • Dump and load databases (offline)
        • Back up, aggregate, and restore (online)
        • Upgrade Neo4j on Kubernetes
        • Migrate Neo4j from Labs Helm to Neo4j Helm charts
        • Scale a Neo4j deployment
        • Use custom images from private registries
        • Assign Neo4j pods to specific nodes
      • Deploy a multi-data center Neo4j cluster
        • Deploy a single Neo4j cluster across AKS clusters
      • Troubleshooting
    • Configuration
      • The neo4j.conf file
      • Command expansion
      • Default file locations
      • Ports
      • Configure network connectors
      • Set an initial password
      • Get initial memory recommendations
      • Plugins
      • Update dynamic settings
      • Migrate configurations
      • Validate configurations
      • Configuration settings
        • Checkpoint settings
        • Cloud storage integration settings
        • Cluster settings
        • Connection settings
        • Cypher settings
        • Database settings
        • DBMS settings
        • Import settings
        • Index settings
        • Logging settings
        • Memory settings
        • Metrics settings
        • Neo4j Browser and client settings
        • Kubernetes settings
        • Security settings
        • Server directories settings
        • Server settings
        • Transaction settings
        • Transaction log settings
    • Import
    • Database administration
      • Database management command syntax
      • Standard databases
        • Naming rules for databases
        • Create, start, and stop databases
        • Create a database from a URI
        • List databases
        • Alter databases
        • Delete databases
        • Migrate a database
        • Upload to Neo4j Aura
        • WAIT options
        • Configuration parameters
        • Error handling
      • Database aliases
        • Naming rules for database aliases
        • Managing database aliases for standard databases
        • Managing database aliases in composite databases
        • Configuring remote database aliases
      • Composite databases
        • Concepts
        • Create, start, and stop composite databases
        • List composite databases
        • Delete composite databases
        • Set up and query composite databases
        • Sharding data with the copy command
      • Query routing decisions
    • Database internals and transactional behavior
      • Transaction management
      • Concurrent data access
      • Transaction logging
      • Checkpointing and log pruning
      • Store formats
      • Display store information
    • Clustering
      • Introduction
      • Setting up a cluster
        • Deploy a basic cluster
        • Deploy an analytics cluster
        • Move from a standalone deployment to a 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
        • Monitor cluster endpoints for status information
        • Monitor replication status
      • Disaster recovery
      • Settings reference
      • Server commands reference
      • Advanced clustering
        • Default database in a cluster
        • Unbind a server
        • Multi-data center routing
        • Reconciler
      • Clustering glossary
    • Backup and restore
      • Backup and restore planning
      • Backup modes
      • Back up an online database
      • Aggregate a database backup chain
      • Inspect the metadata of a backup file
      • Check database consistency
      • Restore a database backup
      • Back up an offline database
      • Restore a database dump
      • Copy a database store
    • Authentication and authorization
      • Manage users
      • Manage roles
      • Recover admin user and password
      • Manage privileges
        • Role-based access control
        • Read privileges
        • Property-based access control
        • Write privileges
        • Database privileges
        • DBMS privileges
        • Load privileges
        • Limitations
        • Procedure and user-defined function privileges
      • Built-in roles and privileges
      • Immutable roles and privileges
      • Integration with auth systems
        • User auth providers
        • LDAP integration
        • Single sign-on integration
    • Security
      • Securing extensions
      • SSL framework
        • Configuring SSL for FIPS 140-2 compatibility
      • Browser credentials handling
      • Security checklist
    • Performance
      • Memory configuration
      • Vector index memory configuration
      • Index configuration
      • Tuning of the garbage collector
      • Bolt thread pool configuration
      • Linux file system tuning
      • 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 connections
      • Manage background jobs
      • Generate a report about the system
    • Neo4j Admin and Neo4j CLI
    • Cypher Shell
    • Procedures
    • Changes, deprecations, and removals
      • Neo4j 2025.x
    • Tutorials
      • Neo4j-admin import
      • Set up and use a Composite database
      • Fine-grained access control
      • Configuring Neo4j Single Sign-On (SSO)
      • Deploy a Neo4j cluster in a Docker container

Is this page helpful?

  • Operations Manual
  • Kubernetes
  • Operations
Raise an issue

Operations

This section describes some maintenance operations when running Neo4j in a Kubernetes cluster.

It covers the following topics:

  • Maintenance mode

  • Reset the neo4j user password

  • Dump and load databases (offline)

  • Back up and restore a single database (online)

  • Upgrade Neo4j on Kubernetes

  • Migrate Neo4j from the Labs Helm charts to the Neo4j Helm charts (offline)

  • Scale a Neo4j deployment

  • Use custom images from private registries

  • Assign Neo4j pods to specific nodes

Monitoring Maintenance modes

Nov 6 2025

The Call for Papers is now open and we want to hear about your graph-related projects. Submit your talks by June 15

Submit your talk

Learn

  • Sandbox
  • Neo4j Community Site
  • Neo4j Developer Blog
  • Neo4j Videos
  • GraphAcademy
  • Neo4j Labs

Social

  • Twitter
  • Meetups
  • Github
  • Stack Overflow
  • Want to Speak?

Contact Us →

  • US: 1-855-636-4532
  • Sweden +46 171 480 113
  • UK: +44 20 3868 3223
  • France: +33 (0) 1 88 46 13 20

© 2025 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.