Skip to content

Latest commit

 

History

History
45 lines (26 loc) · 2.02 KB

install.md

File metadata and controls

45 lines (26 loc) · 2.02 KB

Table of Contents generated with DocToc

Cartography Installation

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 requires Python 3.6 or greater.

  1. Get and install the Neo4j graph database on your server.

    1. Neo4j requires a JVM (JDK/JRE 11 or higher) to be installed. One option is to install Amazon Coretto 11.

    2. Go to the Neo4j download page, click "Community Server" and download Neo4j Community Edition 3.5.*.

       ⚠️ At this time we run our automated tests on Neo4j version 3.5.\*.  Other versions may work but are not explicitly supported. ⚠️

    3. Install Neo4j on the server you will run Cartography on.

  2. Configure your data sources.

  3. Get and run Cartography

    1. Run pip install cartography to install our code.

    2. Finally, to sync your data:

      • If you have one AWS account, run

         cartography --neo4j-uri <uri for your neo4j instance; usually bolt://localhost:7687>

      • If you have more than one AWS account, run

         AWS_CONFIG_FILE=/path/to/your/aws/config cartography --neo4j-uri <uri for your neo4j instance; usually bolt://localhost:7687> --aws-sync-all-profiles

      You can view a full list of Cartography's CLI arguments by running cartography --help

      The sync will pull data from your configured accounts and ingest data to Neo4j! This process might take a long time if your account has a lot of assets.