Skip to end of banner
Go to start of banner

How to install Graphviz software

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Description

The Confluence server must have the Graph Visualization Software (Graphviz) package installed in order for the Graphviz Diagrams for Confluence macros to work. The Graphviz package is free and supports a variety of operating systems including those supported by Confluence. 

Test your Graphviz installation

After you have installed Graphviz, make sure the dot executable is able to be run from a command line using the same environment (especially the path) used to startup Confluence.

If Confluence cannot find the executable, you will get macro errors in Confluence like: No useable executable name ...

Graphviz on Windows

  1. Download and run the Windows installer
    • Defaults to install in C:\Program Files\Graphviz2.16 or similar
    • Automatically adds this to your Windows path
    • Confirm that you can run dot.exe from a newly opened command line
  2. Restart Confluence
  3. Verify it works by creating a page with a simple flowchart macro like:

    {flowchart} 
    A -> B
    {flowchart}

Graphviz on Mac OSX

  1. Download and run the installer.
  2. The installer should set up everything so that dot is found on the path 

Graphviz on Linux and Unix

  1. Install the graphviz.rpm, the graphviz-graphs.rpm, and the graphviz-gd.rpm packages
  2. Open the directory GraphViz is installed under and confirm the path
  3. Login as the user who runs Confluence or starts the Confluence service
  4. Append the path to the bin directory of GraphViz to the 'Path' variable

Last resort

This is not recommended, but, if you just can't get your path set correctly to find the dot executable, then this is an alternative. 

If you get errors about not finding dot.exe

  1. Download the add-on jar file
  2. Unzip the jar to a temporary directory
  3. Edit the graphviz.properties file
    • Replace dot.candidate.paths setting with something like (yes, use forward slashes (smile)):

      dot.candidate.paths=c:/PROGRA~1/Graphviz2.16/bin/dot.exe
      
  4. Zip all files in the temporary directory to create a new jar file
  5. Uninstall the graphviz add-on and re-install your customized version
  6. GVIZ-1 will make this easier


  • No labels