Bitnami Neo4j Virtual Machine

IMPORTANT: The Neo4j OVA has been released for VMware vSphere only. The following information does not apply for VirtualBox or similar VM executors.

Description

Neo4j is a high performance graph store with all the features expected of a mature and robust database, like a friendly query language and ACID transactions.

First steps with the Bitnami Neo4j Stack

Welcome to your new Bitnami application! This guide includes some basic information you will need to get started with your application.

What credentials do I need?

You need two sets of credentials:

  • The application credentials, consisting of a username and password. These credentials allow you to log in to your new Bitnami application.
  • The server credentials, consisting of an SSH username and SSH key file. These credentials allow you to log in to your virtual machine using an SSH client and execute commands on the server using the command line. Contact your datacenter administrator for more information.

What is the administrator username set for me to log in to the application for the first time?

Username: neo4j

What is the administrator password?

Password: The administrator password to log in to your application is randomly generated during the first boot. Check the FAQ to learn how to retrieve it.

What is my server IP address?

The IP address is displayed on screen at the end of the boot process, but you can check it at any time by running the following command:

$ sudo ifconfig

Check server IP address

How to start or stop the services?

Each Bitnami stack includes a control script that lets you easily stop, start and restart services. The script is located at /opt/bitnami/ctlscript.sh. Call it without any service name arguments to start all services:

$ sudo /opt/bitnami/ctlscript.sh start

Or use it to restart a single service, such as Apache only, by passing the service name as argument:

$ sudo /opt/bitnami/ctlscript.sh restart apache

Use this script to stop all services:

$ sudo /opt/bitnami/ctlscript.sh stop

Restart the services by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh restart

Obtain a list of available services and operations by running the script without any arguments:

$ sudo /opt/bitnami/ctlscript.sh

Neo4j default configuration

Neo4j configuration files

Neo4j configuration files are located at the /opt/bitnami/neo4j/conf/ directory.

Neo4j ports

By default, the Neo4j server runs on port 7474. Only conections from localhost are permitted.

Other available ports are the following:

  • HTTPS: 7373
  • Bolt Protocol: 7687

Neo4j log files

Neo4j log files are located at /opt/bitnami/neo4j/logs/ directory. There are two Neo4j log files:

  • /opt/bitnami/neo4j/logs/debug.log
  • /opt/bitnami/neo4j/logs/neo4j.log

What are the default ports?

A port is an endpoint of communication in an operating system that identifies a specific process or a type of service. Bitnami stacks include several services or servers that require a port.

IMPORTANT: Making this application's network ports public is a significant security risk. You are strongly advised to only allow access to those ports from trusted networks. If, for development purposes, you need to access from outside of a trusted network, please do not allow access to those ports via a public IP address. Instead, use a secure channel such as a VPN or an SSH tunnel. Follow these instructions to remotely connect safely and reliably.

Port 22 is the default port for SSH connections.

The Neo4j access port is 7474, 7473, 7687. This port is closed by default. You must open it to enable remote access.

How to connect to Neo4j from a different machine?

The Neo4j OVA can only be deployed within a VMware vSphere environment. For that reason, it does not include any specialized firewall software pre-installed or firewall rules set. It is assumed that this OVA will run on a private LAN.

Please contact your system administrator to learn how to remotely access this machine.

How can I run a command in the Bitnami Neo4j Stack?

Log in to the server console as the bitnami user and run the command as usual. The required environment is automatically loaded for the bitnami user.

How to create a full backup of Neo4j?

Backup

The Bitnami Neo4j Stack is self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

Follow these steps:

  • Change to the directory in which you wish to save your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Create a compressed file with the stack contents:

      $ sudo tar -pczvf application-backup.tar.gz /opt/bitnami
    
  • Restart all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

You should now download or transfer the application-backup.tar.gz file to a safe location.

Restore

Follow these steps:

  • Change to the directory containing your backup:

      $ cd /your/directory
    
  • Stop all servers:

      $ sudo /opt/bitnami/ctlscript.sh stop
    
  • Move the current stack to a different location:

      $ sudo mv /opt/bitnami /tmp/bitnami-backup
    
  • Uncompress the backup file to the original directoryv

      $ sudo tar -pxzvf application-backup.tar.gz -C /
    
  • Start all servers:

      $ sudo /opt/bitnami/ctlscript.sh start
    

If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

How to debug Neo4j errors?

The main Neo4j debug log file is created at /opt/bitnami/neo4j/logs/debug.log.

How to connect to Neo4j?

You can connect to Neo4j from the same server where it is installed with the Neo4j Admin client tool.

Execute the following command:

$ neo4j-admin COMMAND
  • Execute the neo4j-admin help command to check the available commands and Neo4j environment variables.

    You should see an output similar to this:

    Connect to Neo4j

How to operate with the Neo4j database?

Neo4j has its own command-line tool to operate with its database from the same server where it is installed. Cypher Shell allows you to connect to the database, query data, define schema, or perform administrative tasks. Cypher Shell communicates via the encrypted binary protocol Bolt.

  • To connect to the database using the Cypher Shell CLI execute the command below. Remember to replace the PASSWORD placeholder with your application password.

    $ cypher-shell -u neo4j -p PASSWORD
    
  • Once you connect to the database, check the available commands by running the :help; command:

    Connect to Neo4j database

How to start/stop the Neo4j server?

  • To start the Neo4j server, access your machine and execute the following:

    $ sudo /opt/bitnami/ctlscript.sh start neo4j
    
  • To stop the Neo4j server, execute the following:

    $ sudo /opt/bitnami/ctlscript.sh stop neo4j
    
virtualMachine

Bitnami Documentation