---
title: "Installation"
canonical: "https://support.appfire.com/space/DLP/298418755/Installation"
format: markdown
---
> Macro (toc)

> Macro (multiexcerpt-macro)
> 
> <span style="color: #ff5630">LINKI DO KONKRETNYCH PARAGRAFÓW ZOSTAŁY DANE KLIENTOM! OSTROŻNIE Z EDYCJĄ STRONY</span>

## <span style="color: #172b4d">Installation for Jira Cloud</span>

It's only a few clicks. First, go to Jira Administration > Manage apps > "Find new apps" and type "BigTemplate" in the search box. Then, click "Install," accept the terms, and you are almost there. 

The plugin installation may take a while. The "Installed and ready to go!" pop-up on your screen means that the license has been detected and you are all set. However, if it's the first time you use BigTemplate, you may be required to click and navigate to [My Atlassian](https://my.atlassian.com/product) in order to generate an evaluation license.

## <span style="color: #172b4d">Installation for Jira on-prem</span>

> ✅ NodeJS installation is necessary for BigTemplate to work properly. Installation steps can be found below.

### Features unlocked with Headless Chrome

<span style="color: #333333">A quick comparison of image export engines: </span>

|  | Headless Chrome (Starting from BigTemplate 2.7.0) |
| --- | --- |
| Image export formats | PDF (exact export of browser as seen on PC/MAC) |
| Exportables | Gantt, Roadmap, Resources, Risks |

> Macro (anchor)



### <span style="color: #333333">NodeJS Installation</span>

> ℹ️ Installation may be different on your OS. We recommend following the official NodeJS installation guide.
> ℹ️ 
> ℹ️ <span style="color: #333333">Please install NodeJS (version 16.16.0 or higher) using instructions from </span>[<span style="color: #333333">https://docs.npmjs.com/downloading-and-installing-node-js-and-npm</span>](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
> ℹ️ 
> ℹ️ <span style="color: #333333">NodeJS installation guide suggests NVM installation. With </span>**<span style="color: #333333">BigTemplate,</span>**<span style="color: #333333"> you cannot use it. We recommend </span>[<span style="color: #333333">https://www.npmjs.com/package/n</span>](https://www.npmjs.com/package/n)<span style="color: #333333"> if you need a version manager. Using a version manager is optional, and you can also use official NodeJS installers. </span>
> ℹ️ 
> ℹ️ **<span style="color: #333333">Installation check:</span>**  
> ℹ️ <span style="color: #333333">Command "node -v" should return the version of the installed NodeJS.</span>  
> ℹ️ <span style="color: #333333">Command "npm -v" should return the version of the installed NPM.</span>  
> ℹ️ 
> ℹ️ 
> ℹ️ <span style="color: #1d1c1d">You can also provide a path to your </span>**<span style="color: #1d1c1d">npm</span>**<span style="color: #1d1c1d"> executable in BigTemplate > Technical configuration. In such a case, the provided </span>**<span style="color: #1d1c1d">npm</span>**<span style="color: #1d1c1d"> will be used instead of the global one.</span>
> ℹ️ 
> ℹ️ <span style="color: #333333">If you have any further questions regarding setting up NodeJS or if, by any chance, the image export fails afterward, do not hesitate to contact our Support Team via our </span>[<span style="color: #333333">Service Desk</span>](https://appfire.atlassian.net/servicedesk/customer/portal/11)<span style="color: #333333">.</span>

### Font requirements

Exports require TrueType fonts installed on the server. Ask your Jira system administrator to install True Type fonts on the system.

For CentOS/RHEL distributions, it can be done using:

|  |
| --- |
| `sudo yum install -y which fontconfig gnu*fonts` |

For Ubuntu/Debian distributions, it can be done using:

|  |
| --- |
| `sudo apt-get install ttf-mscorefonts-installer` |

or alternatively

|  |
| --- |
| `sudo apt-get install ttf-liberation` |

After the installation, restart your Jira server.

#### Troubleshooting

Q. There is an error "InvalidOperationException: Cannot find any fonts installed on the system." in the logs despite the fonts installed in the system.  
A. It seems like an environmental problem. To fix the issue, symlinks to shared fonts should be created in the JRE fonts directory. e.g.:

|  |
| --- |
| `ln -s /usr/share/fonts/* /opt/atlassian/jira/jre/lib/fonts/` |

Q: After exporting my Gantt view to PDF/PNG, all labels are missing.  
A: This means you probably don't have any fonts installed. Check if there are TrueType fonts in the fonts directory:

- for Ubuntu, openSUSE: /usr/share/fonts
- for Fedora: /usr/local/share/fonts
- for RHEL: /usr/X11R6/lib/X11/fonts
- for CentOS: /usr/share/X11/fonts

If you have the fonts installed, check if fontconfig () is installed and execute fc-cache -v to update font caches.

### <span style="color: #333333">Quick troubleshooting</span>

#### <span style="color: #333333">Export diagnostics</span>

<span style="color: #333333">Please start the troubleshooting by running export diagnostics. </span>

<span style="color: #333333">Go to </span>**<span style="color: #333333">[App configuration](https://appfire.atlassian.net/wiki/spaces/DLP/pages/297570859)</span>****<span style="color: #333333"> > BigTemplate configuration > Technical Info </span>**<span style="color: #333333">and click the "</span>**<span style="color: #333333">Export diagnostics</span>**<span style="color: #333333">" button.</span>

<details>
<summary>Accessing BigTemplate Configuration</summary>

**Method 1: "." (dot) context**

If BigGantt is a Jira add-on, you can use the Jira "." shortcut to access the BigGantt configuration.

1. Press the "." (dot) key shortcut. Jira to open Operations Dialogue.
2. <span style="color: #000c34">Type in "BigTemplate" to narrow down the results:</span>
  
3. <span style="color: #000c34">Click on "BigTemplate configuration" to go directly to app settings in Jira.</span>

**Method 2: Jira administration drop-down**

1. Click the Jira cog at the top right and select "Manage apps" from the list:
2. Select "BigTemplate configuration" on the left:
</details>

![image](media://4a0750f0-638e-4786-9a96-4663af32e620)

![image](media://65b6a7c3-2b3d-49f9-ae6c-379dfff265de)

<span style="color: #333333">If everything is correctly set up, green checkmarks appear:</span>

![image](media://bee57a02-8ba5-4c83-8761-3c2a6062d4af)

<span style="color: #333333">Failures are marked with a red "X":</span>

![image2021-8-31_9-35-36.png](media://b1984162-045a-48ea-876d-22bf424feb72)

##### <span style="color: #333333">Internet connection check - npm status page</span>

Check if the connection to the [https://status.npmjs.org/](https://status.npmjs.org/) site is not blocked from the network where the instance is located (sometimes the problem is caused by the instance being unable to connect to the [https://status.npmjs.org/](https://status.npmjs.org/) site).

##### <span style="color: #333333">Node.js or NPM installation failure</span>

<span style="color: #333333">If Node.js or NPM installation and version are incorrect, follow the above steps.</span>

##### <span style="color: #333333">Temp directory read/write permissions failure</span>

<span style="color: #333333">If the Temp directory read/write permissions are incorrect, move </span>**<span style="color: #333333">Temp directory read permission.</span>**<span style="color: #333333"> </span>

| Linux |
| --- |
| <u>Temp directory write permission:</u><br>1. Go to your Jira Temp dir (if you don't know the path, go to **Getting the path of Jira temp directory **section below).
2. Ensure that the user who runs Jira (by default, a user named Jira) has permission to create files in this directory.
3. Execute the following command: **chmod +w *****path/to/temp/dir*** |
| <u>Temp directory read permission:</u><br>1. Go to your Jira Temp dir (if you don't know the path, go to **Getting the path of Jira temp directory **section below)
2. Ensure that the user who runs Jira (by default, a user named Jira) has permission to create files in this directory.
3. Execute the following command: **chmod +r *****path/to/temp/dir*** |
| <u>Getting the path of Jira temp directory:</u><br>1. Go to Jira → System → System Info
2. Search for the following text: [**<span style="color: #000000">java.io</span>**](http://java.io/)**<span style="color: #000000">.tmpdir</span>**
3. The value of this property is the temp directory path, e.g., */opt/atlassian/jira/temp* |

#### > Macro (anchor)



##### <span style="color: #333333">Export library installation failure</span>

<span style="color: #333333">If the last point is incorrect, click the "</span>**<span style="color: #202124">Re-install pdf export</span>**<span style="color: #333333">" button.</span>

![image](media://e7f5b820-0162-4c88-a97f-8a1e73aeae68)

#### Using NVM as node manager

> ❌ **NVM can't be installed.** If you are currently using NVM, you need to uninstall it.

If you are using NVM as a node manager, even after installing node.js, the application logs will still show that node.js does not exist (can't be found). 

1. Please check if you use NVM as a node version manager - run this command:
  
  to
  
  <span style="color: #172b4d">If it returns anything, that means that NVM is installed.</span>

      2. Uninstall NVM

      3. Install Node.js and NPM

> ✅ Instead of using NVM, you could use [https://www.npmjs.com/package/n](https://www.npmjs.com/package/n)