From 9524c42b6c40e3c845d3eb144679ed671ff3ab47 Mon Sep 17 00:00:00 2001 From: i_virus Date: Wed, 11 Sep 2024 12:04:04 -0400 Subject: [PATCH] #1350: Update install.md (#1351) ### Summary Update document to instruct users to use Neo4j v4.4 or higher ### Related issues or links #1350 ### Checklist Provide proof that this works (this makes reviews move faster). Please perform one or more of the following: - [ ] Update/add unit or integration tests. - [ ] Include a screenshot showing what the graph looked like before and after your changes. - [ ] Include console log trace showing what happened before and after your changes. If you are changing a node or relationship: - [ ] Update the [schema](https://github.com/lyft/cartography/tree/master/docs/root/modules) and [readme](https://github.com/lyft/cartography/blob/master/docs/schema/README.md). If you are implementing a new intel module: - [ ] Use the NodeSchema [data model](https://lyft.github.io/cartography/dev/writing-intel-modules.html#defining-a-node). --- docs/root/install.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/root/install.md b/docs/root/install.md index 6dac56d15..8015f43a0 100644 --- a/docs/root/install.md +++ b/docs/root/install.md @@ -4,11 +4,11 @@ Time to set up the server that will run Cartography. Cartography _should_ work on both Linux and Windows servers, but bear in mind we've only tested it in Linux so far. Cartography supports Python 3.10. Older versions of Python may work but are not explicitly supported. -1. **Run the Neo4j graph database version 4.x** on your server. +1. **Run the Neo4j graph database version 4.4.\*** or higher on your server. ⚠️ Neo4j 5.x will probably work but Cartography does not explicitly support it yet. - 1. If you prefer **Docker**, follow the Neo4j Docker [official docs](https://github.com/neo4j/docker-neo4j) to run a version 4.x container. + 1. If you prefer **Docker**, follow the Neo4j Docker [official docs](https://github.com/neo4j/docker-neo4j) to run a container with version 4.4.\* or higher. - If you are using an ARM-based machine like an M1 Mac, you should use an ARM image otherwise performance will be very slow - Neo4j keeps ARM builds [here](https://hub.docker.com/r/arm64v8/neo4j/).