---
title: "Source Packages"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/getting-started/third-party-software/source-packages/index.html"
---
The Opsview software repositories include the following packages in source form:

- opsview-external
- opsview-jasper
- opsview-monitoring-scripts-base
- opsview-netaudit-external
- opsview-perl-external
- opsview-python3-modules
- opsview-timeseries-influxdb
- opsview-watchdog

The following packages include additional Jasper files licensed under the AGPL. These files are available in source form:

- opsview-reporting-module
- opsview-deploy

See [Accessing AGPL licensed files](#accessing-additional-jasper-agpl-licensed-files) for specifics on retrieval.


**Opsview Agent End of Support**


The `opsview-agent` source package, which included the Opsview Linux Agent, is no longer supported and is not available for download. Deploy all monitoring with the [ITRS Infrastructure Agent](https://docs.itrsgroup.com/docs/infrastructure-agent/current/).



## Adding the repository for your Opsview version

Before you download or build source packages, identify the repository version string that matches your Opsview release.

1. Determine your Opsview version:
   - If Opsview is already installed, check **Configuration > My System** in the UI.
   - If Opsview is not installed, use the latest version.
2. Look up the corresponding repository version string in the [Release Notes](https://docs.itrsgroup.com/docs/all/opsview/opsview-release-notes/index.html).

For example, Opsview version 6.12.3 maps to the repository version string `6.12.3.202606301100`.

Then add the Opsview repository, replacing `VERSION` in the following command with the repository version string:

   ```
   curl -sLo- https://downloads.opsview.com/opsview-commercial/VERSION/deploy | sudo bash -s -- -O repo
   ```

**For RPM systems only:** Add a separate source repository to the Opsview repository file:

   ```
   sudo sed 's/^\[\(.*\)\]/[\1-source]/; s/^name=\(.*\)/name=\1-source/; s|\$basearch|src|' /etc/yum.repos.d/opsview.repo | sudo tee -a /etc/yum.repos.d/opsview.repo
   echo 'skip_if_unavailable=1' | sudo tee -a /etc/yum.repos.d/opsview.repo 
   ```

Finally, on both Debian and RPM systems, update the package index for your package manager. For older Opsview versions, you may see a 404 error for the source repository. You can ignore this error.

## Accessing, building and modifying Source Packages


**Info**


The instructions below use `opsview-watchdog` as an example. You can substitute any available source package except `opsview-python3-modules`.



Follow the instructions for your operating system to access and build from the source packages.
This compiles the original third-party software, applies Opsview changes, and creates a Debian or RPM package for installation.


**Support Policy**


Opsview Ltd does not test or support packages created in this way.



### Debian Source Packages

In the commands below, replace each instance of `opsview-watchdog` with the package name you are building.


**Rebuilds**


If a build fails (for example, due to missing dependencies), delete the current source tree and start again from the beginning to avoid file conflicts.



On a fresh Debian system, complete the following steps:

1. Update the package index and install the build tools:

   ```
   sudo apt-get update
   sudo apt-get install build-essential fakeroot devscripts debhelper
   ```

   - If you are building `opsview-external`, also run `sudo apt-get install python2.7-dev`.
   - If you are building `opsview-jasper`, also install JDK 11 and the JDK development tools.

2. Create a Python virtual environment at `/opt/build-scripts/venv` (this may require additional prerequisites):

   ```
   sudo python3 -m venv /opt/build-scripts/venv
   ```

3. Install `pyyaml` in that virtual environment.

4. [Add the Opsview repository](#adding-the-correct-versioned-repository).

5. Update the package index and install Opsview setup:

   ```
   sudo apt-get update
   sudo apt-get install opsview-setup
   ```

6. Edit `/etc/apt/sources.list.d/opsview.list` and change `deb` to `deb-src` so apt can access the sources repository.

7. Update the package index again:

   ```
   sudo apt-get update
   ```

8. As a non-root user, download and extract the source package into the current directory:

   ```
   apt-get source opsview-watchdog
   ```

9. Change to the extracted source directory:

   ```
   cd opsview-watchdog-*
   ```

10. Make any required modifications using standard Debian packaging practices.

11. Build the package:

    ```
    make package
    ```

    - Additional build-dependent packages may be required.
    - On Ubuntu, if `/usr/bin/python2` is missing, create a symlink and continue the build:

      ```
      sudo ln -s /usr/bin/python2.7 /usr/bin/python2
      ```

12. After a successful build, locate the `.deb` file in the parent directory.

### RPM Source Packages

In the commands below, replace each instance of `opsview-watchdog` with the package name you are building.


**Rebuilds**


If a build fails (for example, due to missing dependencies), delete the current source tree and start again from the beginning to avoid file conflicts.



On a fresh RPM platform, complete the following steps:

1. Install the build tools:

   ```
   sudo yum install rpm-build redhat-rpm-config perl-TimeDate yum-utils
   ```

   - If you are building `opsview-external`, also run `sudo yum install python-devel` (on RHEL 8/OL 8, use `sudo yum install python2-devel`).
   - If you are building `opsview-jasper`, also install JDK 11 and the JDK development tools.

2. [Add the Opsview repository](#adding-the-correct-versioned-repository).

3. Install Opsview setup:

   ```
   sudo yum install opsview-setup
   ```

4. Download the source RPM:

   ```
   yumdownloader --source opsview-watchdog
   ```

5. Make any required modifications using standard RPM packaging practices.

6. To build the source as-is, run:

   ```
   sudo rpmbuild --define "__arch_install_post /bin/true" --rebuild *.src.rpm
   ```

   Built RPMs are placed in `/root/rpmbuild/RPMS/`. The source location may differ if you make modifications.

   - Additional build-dependent packages may be required.
   - You may need to install [EPEL](https://fedoraproject.org/wiki/EPEL) for these dependencies.

### Installing modified packages


**Replacing opsview-jasper**


See [Replacing opsview-jasper](#replacing-opsview-jasper-and-agpl-files) for instructions on installing your own built drop-in replacement for opsview-jasper and other AGPL files, which differs from these general instructions.



To install a package that you have built:

1. Install the package manually with the appropriate package manager on your Opsview system.
2. Rerun the `setup-everything.yml` playbook across the entire system.
3. Restart all components.


**Support Notice**


Packages built in this way are not covered by the Opsview support policy, even if the source is unmodified.



## Plugins

In addition to the source packages listed above, the opsview-opspacks package contains the following third-party plugins within Opspacks:

- database-microsoft-sql.tar.gz
  - [check_mssql_database](https://github.com/NagiosEnterprises/check_mssql_collection/blob/master/check_mssql_database.py)
- san-netapp.tar.gz
  - [check_netapp3.pl](https://exchange.nagios.org/directory/Plugins/Hardware/Storage-Systems/SAN-and-NAS/NetApp/Check_netapp3/details)
- application-dell-hardware.tar.gz
  - [check_openmanage](https://github.com/trondham/check_openmanage)
- database-oracle-rdbms.tar.gz
  - [check_oracle_health](https://labs.consol.de/nagios/check_oracle_health/index.html)
- os-vmware-vsphere-host.tar.gz
  - [check_vmware_api](https://exchange.nagios.org/directory/Plugins/Operating-Systems/%2A-Virtual-Environments/VMWare/check_vmware_api/details)
- os-windows-winrm-base-agentless.tar.gz
  - [check_windows_updates.ps1](https://exchange.nagios.org/directory/Plugins/Operating-Systems/Windows-NRPE/Check-Windows-Updates-using-Powershell/details)

To download the source and modifications made to these plugins follow the instructions below. Any patches to plugins that Opsview has produced are automatically applied as part of the distribution of Opspacks.

### Install opsview-opspacks package

You will need to install opsview-opspacks to get the instructions and bring in other dependencies before you can extract the source code for Opspack plugins and apply provided patches.

#### Setup Opsview Repositories

[Add the Opsview repository](#adding-the-correct-versioned-repository).

#### RHEL/OL

Update yum and install opsview-opspacks:

```
sudo yum makecache
sudo yum install opsview-opspacks
```

#### Debian/Ubuntu

Update apt and install opsview-opspacks:

 ```
sudo apt-get update
sudo apt-get install opsview-opspacks
 ```

### Extract plugin

Extract the package for the Opspack you want to view. For example, `database-oracle-rdbms.tar.gz`.

```
tar -zxvf /opt/opsview/monitoringscripts/opspacks/<name_of_opspack>.tar.gz
cd <name_of_opspack>
```

Follow the instructions found in the `README.md` file to patch the plugin file(s).
If there isn't a `README.md` or a patches directory, then Opsview has not made any patches to the plugin.

### Installing modified plugins

To install a modified plugin, import it under a new name by using the UI, API, or CLI.


**Support Notice**


Plugins built in this way are not covered by the Opsview support policy, even if the source is unmodified.



## Accessing the opsview-python3-modules source package

You can access the source code for the opsview-python3-modules package and apply our modifications to the code by following the instructions below.

### Debian system

On a fresh Debian system, complete the following steps:

1. Update the package index and install the build tools:

   ```
   sudo apt-get update
   sudo apt-get install build-essential fakeroot devscripts debhelper
   ```

2. [Add the Opsview repository](#adding-the-correct-versioned-repository).

3. Edit `/etc/apt/sources.list.d/opsview.list` and change `deb` to `deb-src` so apt can access the sources repository.

4. Update the package index again:

   ```
   sudo apt-get update
   ```

5. As a non-root user, download and extract the source package into the current directory:

   ```
   apt-get source opsview-python3-modules
   ```

6. Change to the extracted source directory:

   ```
   cd opsview-python3-modules-*
   ```

   You can view the source code and patch files in this directory structure.

7. Apply all modifications:

   ```
   make patches-external
   ```

   Patched libraries are available as `.tar.gz` archives in `build/index`.

   Additional build-dependent packages may be required.

### RPM system

On a fresh RPM platform, complete the following steps:

1. Install the build tools:

   ```
   sudo yum install rpm-build redhat-rpm-config perl-TimeDate yum-utils
   ```

2. [Add the Opsview repository](#adding-the-correct-versioned-repository).

3. Download the source RPM:

   ```
   yumdownloader --source opsview-python3-modules
   ```

4. Extract the source RPM contents, then extract the resulting archive:

   ```
   rpm2cpio opsview-python3-modules-*.src.rpm | cpio -id
   tar -xzf opsview-python3-modules-*.tar.gz
   ```

5. Change to the extracted source directory:

   ```
   cd opsview-python3-modules-*
   ```

   You can view the source code and patch files in this directory structure.

6. Apply all modifications:

   ```
   make patches-external
   ```

   Patched libraries are available as `.tar.gz` archives in `build/index`.

   Additional build-dependent packages may be required.

## Accessing Additional Jasper AGPL-Licensed Files

The following AGPL-licensed files are included in source form in the binary packages.
They are used to configure and theme Jasper Server after you install the `opsview-jasper` package, and are not required to build the package.

Location on an installed system:
- opsview-reporting-module:
  - Jasper themes zipped inside:
    - `/opt/opsview/jasper/installer/default-themes.zip`
    - `/opt/opsview/jasper/installer/opsview-theme.zip`
  - DB schema/upgrades:
    - `/opt/opsview/jasper/installer/initial.sql`
    - `/opt/opsview/jasper/installer/upgradedb_jasperserver.pl`
- opsview-deploy
  - Jasper templates:
    - `/opt/opsview/deploy/lib/roles/opsview_reporting/templates/jasper-web.xml.j2`
    - `/opt/opsview/deploy/lib/roles/opsview_reporting/templates/jasper-externalAuth.xml.j2`
    - `/opt/opsview/deploy/lib/roles/opsview_reporting/templates/jasper-context.xml.j2`
    - `/opt/opsview/deploy/lib/roles/opsview_reporting/templates/jasper-js.jdbc.properties.j2`


**Note**


All other content in the package, including ITRS images and icons, is ITRS proprietary, except `/opt/opsview/jasper/lib/Opsview/Jasper/Config.pm`. That file is licensed under [MIT-0](https://opensource.org/license/mit-0) and may be used or modified freely.



To access the files without installing:

1. [Add the Opsview repository](#adding-the-correct-versioned-repository).
2. Create temporary workspace dirs:

   ```
   cd /tmp
   mkdir -p /tmp/reporting-module /tmp/deploy
   ```

3. Update the package index, download the binary packages using your package manager, and unpack them:

   ```
   cd /tmp

   # then, on Debian systems:

   sudo apt-get update
   apt-get download opsview-reporting-module opsview-deploy
   dpkg-deb -x opsview-reporting-module_*.deb /tmp/reporting-module
   dpkg-deb -x opsview-deploy_*.deb /tmp/deploy
   
   # OR on RPM systems:
   
   sudo dnf makecache
   sudo dnf install rpm-build
   dnf download opsview-reporting-module opsview-deploy
   cd /tmp/reporting-module
   rpm2cpio ../opsview-reporting-module-*.rpm | cpio -idm
   cd /tmp/deploy
   rpm2cpio ../opsview-deploy-*.rpm | cpio -idm
   ```

4. Unzip themes from opsview-reporting-module:

   ```
   mkdir -p /tmp/default-themes /tmp/opsview-theme
   cd /tmp/reporting-module
   unzip opt/opsview/jasper/installer/default-themes.zip -d /tmp/default-themes
   unzip opt/opsview/jasper/installer/opsview-theme.zip -d /tmp/opsview-theme
   ```

5. Find opsview-reporting-module schema scripts from the path listed above, under `/tmp/reporting-module`.
6. Find opsview-deploy templates from the path listed above, under `/tmp/deploy`.

## Replacing `opsview-jasper` and AGPL Files


**Support Notice**


The Reporting Module is not covered by the Opsview support policy when you run it this way, even if the source is unmodified.



After you build your `opsview-jasper` package according to the [instructions](#accessing-building-and-modifying-source-packages):

1. Copy the built package onto your Opsview orchestrator.
2. Manually install the package using the appropriate package manager.
3. If needed, edit the `opsview-deploy` Jasper templates in place.
4. If needed, unzip the `opsview-reporting-module` theme files, edit them, then re-zip them into the same structure, location, and permissions.
5. If needed, edit the schema files in `opsview-reporting-module` in place.
6. Manually run the `opsview-deploy` `reporting-install.yml` playbook with the following override:

   ```
   /opt/opsview/deploy/bin/opsview-deploy -e opsview_reporting_package_state=present /opt/opsview/deploy/lib/playbooks/reporting-install.yml
   ```

   If you change the database schema in `initial.sql`, delete the `jasperserver` database so it can be recreated and the changes take effect.

7. Restart the `opsview-reportingmodule` service:

   ```
   /opt/opsview/watchdog/bin/opsview-monit restart opsview-reportingmodule
   ```

The Reporting Module is then available using your built package and updated files.


**Support Notice**


Changes may not persist through a standard Opsview upgrade if newer packages overwrite modified packages.
After an upgrade, repeat the steps above to replace the standard files again.




