Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxlevel3
minlevel2
typeflat
separatorpipe

...

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. 

Tip
titleTest 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 ...

Downloading Graphviz

Before you can use Graphviz Diagrams for Confluence you will need to download and install Graph Visualization Software (Graphviz) on the system where you are running Confluence.  Download the correct version of the software that matches your environment.  You can find the available versions on the Graphviz Downloads page.  Once the download is complete then following the instructions below for your operating system. 

Graphviz on Windows

  1. Download the installer from this link
  2. The default installation path will be C:\Program Files (x86)\GraphvizX.XX\bin (Example: GraphvizX.XX → Graphviz2.38)
  3. Open cmd window as administrator and

    run the Windows installerDefaults to install in

    go the location C:\Program Files (x86)\GraphvizX.XX\bin and run the below command

    No Format
    dot.exe


  4. Exit the command window.

  5. Go to the Control Panel →  System and Security → System and on the right side navigation panel you will see the link Advanced systems settings.

  6. Once there in advance settings, a dialogue box will open which will show the button Environment Variables. Click on the button Environment Variables.

  7. Select the entry "Path" on system variables section and add C:\Program Files (x86)\

    Graphviz2.16 or similar
  8. Automatically adds this to your Windows path
  9. Confirm that you can run dot.exe from a newly opened command line

    GraphvizX.XX\bin to the existing path. Please see the below screenshot for reference.                                    Image AddedImage Added 
    Note: Please make sure you add ";" at the PATH which is already existing under User Variables and mention the path C:\Program Files (x86)\GraphvizX.XX\bin. Also please add a New path on the system variables section and add the Path C:\Program Files (x86)\GraphvizX.XX\bin

  10. Click on Ok Button. 
  11.  Restart Confluence from a new cmd window.
  12. Go to system information page on confluence instance.
  13.  Verify if you are able to see C:\Program Files (x86)\GraphvizX.XX\bin on "Path" attribute on system information page in confluence.
  14. If the path is available that means that the configuration changes are successful. 
  15. Go the page where you have used the macro and verify if the add-ons works.
  16. Restart Confluence
  17. Verify it works by creating a page with a simple flowchart macro like:


    No Format
    {flowchart} 
    A -> B
    {flowchart}


...

  1. Follow the instructions mentioned here.
  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 should not be needed and is not recommended, but, if you just can't get your path set correctly to find the dot executable, then this is an alternative. 

Info
titleIf 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)):

      No Format
      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

...