Documentation
ShellGraph makes a map of the dependencies between the services on your Linux servers. It finds which service calls which service, on the same server and between servers.
ShellGraph installs nothing on the servers. It connects with SSH, reads the processes and the sockets, and then disconnects.
Components
| Component | Program | Function |
|---|---|---|
| Server | shellgraph-server | Keeps the configuration and the data in SQLite. Shows the web UI and the map. It does not connect to the servers that it maps. |
| Collector | shellgraph | A command line program. It scans one VLAN with SSH and sends one report to the server. |
Two programs are necessary because the web server often cannot connect to all networks. Install the collector on a machine that can connect to the target servers with SSH and to the server with HTTPS.
browser ──HTTPS──► shellgraph-server ◄──HTTPS── shellgraph (collector)
│
└──SSH──► servers in the VLAN
How this documentation is organized
Each component has the same four sections:
| Section | Use it when you want to |
|---|---|
| Tutorials | Learn ShellGraph with a complete task in the lab. |
| How-to guides | Do one task on your own servers, for example install the server or schedule scans. |
| Reference | Find a fact: a flag, a variable, a status, a field of the report. |
| Explanation | Understand how ShellGraph works and why: the rules of the map, the rescans, the security. |
Start with Make your first map.