Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Linkurious/docker-neo4j
Neo4J helper repository to run Neo4j with docker-compose
https://github.com/Linkurious/docker-neo4j
database devops docker docker-compose neo4j
Last synced: 3 months ago
JSON representation
Neo4J helper repository to run Neo4j with docker-compose
- Host: GitHub
- URL: https://github.com/Linkurious/docker-neo4j
- Owner: Linkurious
- License: apache-2.0
- Created: 2020-09-14T14:04:44.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-28T11:15:38.000Z (8 months ago)
- Last Synced: 2024-05-29T02:50:23.839Z (8 months ago)
- Topics: database, devops, docker, docker-compose, neo4j
- Language: Shell
- Homepage:
- Size: 148 KB
- Stars: 10
- Watchers: 5
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dockerized repository
## Usage
### Clone
To use this repo, you must first clone it locally
```sh
git clone [email protected]:Linkurious/docker-neo4j.git
cd ./docker-neo4j
```
### Configure
Configure variables in .env. See .env.example for template.
Reasonable defaults are provided. Simply use them when working localy.
```sh
ln -s .env.example .env
ln -s .env.neo4j.v4.example .env.neo4j.v4.dev
```
### Start Neo4j
Run with docker-compose
Neo4j v4
```sh
docker-compose up -d
```
Neo4j v5
```sh
docker-compose -f docker-compose.v5.yml -f docker-compose.override.yml up -d
```
### Start Neo4j cluster
Neo4j v4
```sh
ln -s .env.neo4j.v4.example .env.neo4j.v4.dev
docker-compose -f docker-compose.cluster.v4.yml -f docker-compose.cluster.override.yml up -d
```
Neo4j v5
```sh
ln -s .env.neo4j.v5.example .env.neo4j.v5.dev
docker-compose -f docker-compose.cluster.v5.yml -f docker-compose.cluster.override.yml up -d
```
## Browse database when working localy
Go to http://localhost:7474 and connect with the following parameters:
- Connect URL: bolt://localhost:7687
- Database: _leave empty_
- Authentication type: Username / Password
- Username: neo4j
- Password: neo3j
## Neo4j v3 restore
```sh
docker-compose -f docker-compose.yml -f docker-compose.shell.yml run --rm neo4j bash
```
From dev env:
```sh
docker-compose -f docker-compose.yml -f docker-compose.override.yml -f docker-compose.shell.yml run --rm neo4j bash
```
## Backup and restore (Neo4j V4)
see https://neo4j.com/docs/operations-manual/current/backup/
When working localy, docker-compose.override.yml adds a local bind mount to the /backups folder.
Backups can be downloaded from Nexus. They have to be decompressed in the ./backups bind mounted folder.
Create an online backup (command to be executed in the context of the neo4j container, with `docker-compose exec neo4j`):
```sh
neo4j-admin backup --backup-dir /backups --database crunchbase-1.0.0
```
Restore/create from dataset:
```sh
neo4j-admin restore --from /datasets/4.2.0/crunchbase --database crunchbase-1.0.0 --verbose
```
Restore from backup:
```sh
neo4j-admin restore --from /backups/4.2.0/crunchbase --database crunchbase-1.0.0 --verbose
```
in v3.5.x
```sh
neo4j-admin restore --from /backups/3.5.15/fincrime-1.0.0/ --database graph.db
```
On first creation of a db, you will have to:
```
:use system
CREATE DATABASE `crunchbase-1.0.0` WAIT;
```
You can then check that the db has succesfully been restored with:
```
:use crunchbase-1.0.0
match (n) return n limit 10
```
### Offline load
```
neo4j-admin load --from=/datasets/crunch.3.5.15 --database=crunchbase-1.0.0
```
and create the database via cypher-shell (the credential are specified in the .env.neo4j.dev at the root of you repository) :
```
cypher-shell
CREATE DATABASE crunchbase;
```
## Plugins
### Apoc
see https://neo4j.com/labs/apoc/4.4/installation/
Download the appropriate version of apoc plugin and drop it in the plugins folder:
```sh
curl -L https://github.com/neo4j-contrib/neo4j-apoc-procedures/releases/download/4.4.0.11/apoc-4.4.0.11-all.jar -o plugins/apoc-4.4.0.11-all.jar
```
Warning: Check the matching version for your version of Neo4j
### Aura
## load db
From a shell, stoped database :
```sh
bin/neo4j-admin push-to-cloud --bolt-uri neo4j+s://XXXXX.databases.neo4j.io --database=fincrime-1.0.0 --overwrite
```
### Nexus datasets
## Manual upload for large datasets
```sh
export dataset_name=fincrime-sales
export dataset_version=1.0.0
curl -L -v --user [email protected]:${USER_PWD} --upload-file ${dataset_name}-${dataset_version}.tgz https://nexus3.linkurious.net/repository/datasets/com/linkurious/neo4j/4.2.4/${dataset_name}/${dataset_name}-${dataset_version}.tgz
```
## Download dataset
```sh
export dataset_name=fincrime-sales
export dataset_version=1.0.0
curl -L -v --user [email protected]:${USER_PWD} https://nexus3.linkurious.net/repository/datasets/com/linkurious/neo4j/4.2.4/${dataset_name}/${dataset_name}-${dataset_version}.tgz
```