Skip to content

Uses Confluence REST API and Graphviz to provide graph visualization of all pages in Confluence space. Originally forked, but I had to rewrite it from scratch and needed to take it private to polish the actual docs

License

Notifications You must be signed in to change notification settings

vineetparikh/conflugraph

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

conflugraph

Graph visualizer for page hierarchy of a Confluence space

Uses Confluence REST API for fetching information on spaces. Authorized with NTLM (although it's possible to change authorization methods easily), and uses graphviz for graphical presentation

Requirements:

Usage:

$ git clone https://github.com/vineetparikh/conflugraph.git
$ cd conflugraph
$ sudo -H pip install -r requirements.txt
$ python confluence-graph.py --user=your-username --password=your-password --confluence=url-of-your-confluence-site --space=your-confluence-space-key

Docker support should work with

$ git clone https://github.com/vineetparikh/conflugraph.git
$ cd conflugraph
$ docker build -t conflu .
$ docker run -v $PWD/out:/out conflu python confluence-graph.py (...)

Advanced Usage:

List of all configuration options with descriptions:

python confluence-graph.py --help

Configuring Splines

While this doesn't matter as much with small graphs, as graphs scale with nodes and edges, edges tend to overlap nodes rather annoyingly. Fixing this, especially for bigger graphs, means configuring splines, but this vastly increases rendering time.

$ python confluence-graph.py --user=your-username --password=your-password --confluence=url-of-your-confluence-site --space=your-confluence-space-key --splines=(True or False)

Authentication

This tool configures NTLM authentication, as this was required for testing with Cornell's Confluence system. Since authentication types are integrated into request "sessions," porting between individual authentications is straightforward: I just don't know which ones would be valuable to include. At this point I'll most likely be adding basic authentication (BAuth) and NTLM authentication.

About

Uses Confluence REST API and Graphviz to provide graph visualization of all pages in Confluence space. Originally forked, but I had to rewrite it from scratch and needed to take it private to polish the actual docs

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published