Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added DozerDB_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
77 changes: 58 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,72 @@
# README
<p align="center">
<img src="./DozerDB_logo.png" width="400" alt="DozerDB">
</p>

<p align="center">
<em>Plugin build for DozerDB — combines core and browser into a single deployable artifact</em>
</p>

## About
DozerDb enhances Neo4j core / AKA Neo4j Community Edition with enterprise features.
<p align="center">
<a href="https://github.com/dozerdb/dozerdb-plugin/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GPLv3-blue?style=for-the-badge" alt="License"></a>
<a href="#-development"><img src="https://img.shields.io/badge/Java-17+-orange?style=for-the-badge&logo=openjdk&logoColor=white" alt="Java 17+"></a>
<a href="https://neo4j.com"><img src="https://img.shields.io/badge/Neo4j-5.26.22-green?style=for-the-badge&logo=neo4j&logoColor=white" alt="Neo4j"></a>
</p>

This project builds the actual plugin which is used to enhance Neo4j Community Edition.
<p align="center">
<a href="https://dozerdb.org"><img src="https://img.shields.io/badge/Get_Started-FF6600?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Get Started"></a>
<a href="mailto:info@greystonesgroup.com"><img src="https://img.shields.io/badge/Contact_Us-333333?style=for-the-badge&logo=gmail&logoColor=white" alt="Contact Us"></a>
</p>

See https://dozerdb.org for installation instructions.
---

## Versioning
The plugin combines the dozerdb-core and dozerdb-browser artifacts into an uber jar which is dropped into the Neo4j lib directory and takes control of the bootstrap process.
## 📋 About

The version uses the current Neo4j full version number and appends the final number anytime the dozerdb-core or dozerdb-browser projects have an update.
DozerDB enhances Neo4j Community Edition with enterprise features. This project builds the plugin — an uber JAR that combines [dozerdb-core](https://github.com/dozerdb/dozerdb-core) and [dozerdb-browser](https://github.com/dozerdb/dozerdb-browser) into a single artifact.

Example - for Neo4j version 5.26.22 - the first release would be 5.26.22.0.
If a change occurs within the dozerdb-browser or dozerdb-core package - then the version would become: 5.26.22.1 and so on.
The plugin JAR is dropped into the Neo4j `lib` directory and takes control of the bootstrap process.

## Development
Please ensure you use java 17 or above when working on the plugin.
Visit **[dozerdb.org](https://dozerdb.org)** for installation instructions.

If you would like to use an open source java version manager - please check out https://sdkman.io/
For those using sdkman - you can use the following command to switch to the favor of openjdk that we use.
---

## 🔢 Versioning

The plugin version uses the current Neo4j full version number and appends a release number for DozerDB updates:

## Building
Ensure you have JDK 17+ first or you will get compile errors.
| Neo4j Version | DozerDB Release | Plugin Version |
|---------------|-----------------|----------------|
| 5.16.0 | First release | `5.16.0.0` |
| 5.16.0 | Browser update | `5.16.0.1` |
| 5.16.0 | Core fix | `5.16.0.2` |

To build the project - you can run the following command:
```
./mvnw clean verify
The final number increments whenever `dozerdb-core` or `dozerdb-browser` has an update.

---

## 🛠️ Development

### Prerequisites

- **Java 17+** is required. You will get compile errors with older versions.
- We recommend [SDKMAN!](https://sdkman.io/) as an open source Java version manager.

### Building

```bash
./mvnw clean verify
```

---

## 📞 Support

<p>
<a href="mailto:info@greystonesgroup.com"><img src="https://img.shields.io/badge/Email_Us-info@greystonesgroup.com-FF6600?style=flat-square&logo=gmail&logoColor=white" alt="Email Us"></a>
<a href="https://github.com/dozerdb/dozerdb-core#-support"><img src="https://img.shields.io/badge/More_Info-dozerdb--core-333333?style=flat-square&logo=github&logoColor=white" alt="More Info"></a>
</p>

---

<p align="center">
<sub>&copy; 2026 DozerDB Contributors</sub>
</p>