Description

The Confluence server must have the Graph Visualization Software (Graphviz) package installed in order for the 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. 

Downloading Graphviz

Before you can use use Graphviz Diagrams for Confluence, you will need to must download and install 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 , follow the instructions given below for your operating system. 

Graphviz on Windows

1. Download the installer from this link.
2. The default installation path will be is: C:\Program Files (x86)\GraphvizX.XX\bin (Example: GraphvizX.XX → Graphviz → Graphviz 2.38)

3. Open cmd command line window as administrator and go the location C:\Program Files (x86)\GraphvizX.XX\bin and run the below following command:

   No Format
   dot.exe

   
   

4. Exit the command line window.

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

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

7. Anchor
   gviz_install_step7 gviz_install_step7

   Select the entry "Path" on  in the system variables section and add C:\Program Files (x86)\GraphvizX.XX\bin to the existing path. Please see the below screenshot for reference.                                    Image RemovedImage Removed 
   Note:
   Image AddedImage Added

   Note
   Please make sure you add ";" at the PATH which

   is

   already

   existing

   exists under User

   Variables

   variables and mention the path C:\Program Files (x86)\GraphvizX.XX\bin.

    Also

   Also please add a

   New

   new path on the

   system

   System variables section and add the

   Path

   C:\Program Files (x86)\GraphvizX.XX\bin path.

   
   

8. Click

   on Ok Button

   OK. 

9.  Restart Confluence from a new cmd command line window.
10. Go to the system System information page on confluence in your Confluence instance.
11. Verify if you can see C:\Program Files (x86)\GraphvizX.XX\bin on " in the Path" attribute on system information the page in confluence. If the path is available, that means that the configuration changes are successful. 
12. Go the page where you have used the macro and verify if the add-ons apps work.
13. Restart Confluence.

14. Verify it the app works by creating a page with a simple flowchart macro likesuch as:

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

    
    

Graphviz on Windows for

...

v2.38 or later

In the Graphviz download link

...

, it shows 2.38 as the latest version, but as of today, 2.43.x is the latest version for Windows.

...

Graphviz team

...

intends to make it available on the web as per

...

 this reference and this other reference.

1. As per Graphviz team's suggestion, use the latest executable and missing config, that is, graphviz-2.43 file in this available on their page.
2. So, you need to You must install the .exe and copy the config6 file in the bin folder after successful installation. Note that if config6 file is comes with installation, you can skip copying it manually to the bin folder.
3. After the installation is completed complete, follow the steps 7-15 mentioned above in the previous section with the latest 2.43.x version of the graphvizGraphviz.
4. Check with dot -V at the command prompt whether you your changes are reflected.As we are finding some

...

...

...

...

Graphviz on Mac OSX

1. Follow the instructions mentioned here.
2. The installer should set usually sets up everything so that the dot  appears under on the path  appears under the Path variable.

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 where Graphviz is installed under and confirm the path.
3. Log in as the user who runs Confluence or starts the Confluence service.
4. Append the path to the bin directory of GraphViz Graphviz to the 'Path' variable.

Graphviz on Ubuntu

1. Install the Graphviz packages with the following set of commands: 

   Code Block
   apt-get update apt-get install graphviz*

   
   

Last resort

The method mentioned in this section is not required and not recommended in most cases, but, if you can't get your path set correctly . Use this as an alternative if you are not able to set your path correctly to find the dot executable, then this is an alternative.