Build and run

This is a preview of the documentation of Neodash version 3.0.2. For the latest release, refer to Neodash commercial 3.0.1.

To start developing the application, you must set up the development environment.

Run locally with Docker

Pull the latest image from Docker Hub to run the application locally:

# Run the application on http://localhost:5005
docker pull neo4j/neodash-commercial
docker run -it --rm -p 5005:5005 neo4j/neodash-commercial

# If you want to run on a custom port, set an environment variable
export NGINX_PORT=5008
docker run -it --rm -e NGINX_PORT=5008 -p 5008:5008 neo4j/neodash-commercial

Windows users may need to prefix the docker run command with winpty.

Build a Docker image

A pre-built Docker image is available on Docker Hub. This image is built using the default configuration (running in editor mode, without SSO).

Building the image yourself

Make sure you have a recent version of Docker installed to build the multi-stage NeoDash image and run it.

On Unix (Mac/Linux) systems:

docker build . -t neodash

If you use Windows, you might need to prefix the command with winpty:

winpty docker build . -t neodash

After building, you can run the image with:

docker run -it –rm -p 5005:5005 neodash

Run on Kubernetes

An example of a pod definition YAML file to create a NeoDash pod in a cluster:

apiVersion: v1
kind: Pod
metadata:
  name: neodash
  labels:
    project: neodash
spec:
  containers:
    - name: neodash
      image: neo4jlabs/neodash:latest
      ports:
        - containerPort: 5005

Creating a Kubernetes service to expose the application:

apiVersion: v1
kind: Service
metadata:
    name: neodash-svc
spec:
    type: LoadBalancer
    ports:
    - port: 5005
      targetPort: 5005
    selector:
      project: neodash