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.8. Older versions of Python may work but are not explicitly supported.
Get and install the Neo4j graph database on your server.
Neo4j requires a JVM (JDK/JRE 11 or higher) to be installed. One option is to install Amazon Coretto 11.
⚠️ Make sure you have `JAVA_HOME` environment variable set. The following works for Mac OS: `export JAVA_HOME=$(/usr/libexec/java_home)`
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. ⚠️
Install Neo4j on the server you will run Cartography on.
⚠️ For local testing, you might want to turn off authentication via property `dbms.security.auth_enabled` in file /NEO4J_PATH/conf/neo4j.conf
Configure your data sources. See the configuration section of each relevant intel module for more details.
Get and run Cartography
pip install cartographyto install our code.
Finally, to sync your data:
For one account using the
defaultprofile defined in your AWS config file, run
cartography --neo4j-uri <uri for your neo4j instance; usually bolt://localhost:7687>
Or for a specific account defined as a separate profile in your AWS config file, set the
AWS_PROFILEenvironment variable, for example
AWS_PROFILE=other-profile cartography --neo4j-uri <uri for your neo4j instance; usually bolt://localhost:7687>
For 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
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.
See our Operations Guide for tips on running Cartography in production.