Jasper Publisher

_images/JRI-Publisher-Main.png

Intro

Overview

JRI Publisher is a Webmin module that installs, configures, and manages Tomcat, Java, and JasperReportsIntegration

It also provides Publishing, Scheduling, Email Formatting, and Report Management.

It can be used with or without Oracle APEX.

In additional to Oracle, JRI Publisher includes one-click JNDI support for PostgreSQL, MySQL, and SQL Server.

_images/JRI-Publisher-Main.png

Use Cases

  • Those looking for the advanced functionality JRI Publisher adds to JasperReportsIntegration (UI, Scheduling, Email Templates, and Dashboard)
  • Non-APEX Oracle, PostgreSQL, MySQL, and MSSQL users who want a Jasper reporting solution. While JasperReportsIntegration was designed for Oracle APEX (and can be used with Oracle APEX), JRI Publisher does not require APEX or installing the JRI SQL objects.

System Requirements

  • CentOS 8 or
  • Ubuntu 18 or 20
  • Postfix
  • 1 GB Ram
  • 10 GB SSD

Open Source

JRI Publisher is Free, Open Source Software.

GNU GENERAL PUBLIC LICENSE v3

Installation

Installation can be done using the pre-installer.sh script or via GIT.

Using the Pre-Installer

On a fresh CentOS 8 or Ubuntu 18 or 20 installation, the fastest method is to use the pre-installer script:

1
2
3
4
5
 wget https://raw.githubusercontent.com/DavidGhedini/jri-publisher/master/scripts/pre-install.sh

 chmod +x pre-install.sh

 ./pre-install.sh

The above will install Webmin, Apache HTTPD Server, JRI Publisher module, as well as our (optional) Certbot Module for SSL.

When the script completes, you will see the message below:

1
2
3
4
 /opt ~
 Installed CertBot in /usr/share/webmin/certbot (336 kb)
 ~
 JRI Publisher is now installed. Go to Servers > JRI Publisher to complete installation

Note

Following above, you will need to log in to Webmin to complete installation using the install Wizard.

Via Git or Download

You can use Git to build module for an existing Webmin installation:

1
2
3
 git clone https://github.com/DavidGhedini/jri-publisher
 mv jri-publisher-master jri_publisher
 tar -cvzf jri_publisher.wbm.gz jri_publisher/

Note

Following above, you will need to log in to Webmin to complete installation using the install Wizard.

Postfix

In order to use the email functionality for Report Scheduling, a working MTA is required.

If one is not already installed, the simplest to install is Postfix.

Postfix can be installed on Webmin.

Navigate to Servers > Unused Modules > Postfix Mail Server

Accept the defaults and click “Install Now” as shown below.

_images/Postfix-install.png

Wizard

Once the module is installed, the Wizard is used to configure the components.

Go to Servers > JRI Publisher:

_images/3.png

The main Wizard screen will a link for completing each step.

While most steps are self-explanatory, we will cover Tomcat, JDK, and JRI selection below:

Install Java/JDK:

_images/4-java.png

Select the JDK you wish to use. We have tested with JDK 8

_images/5-java.png

JRI Publihsher has been tested with OpenJDK 8 and Oracle JDK 8.

Apache Tomcat

_images/8-tomcat.png

JRI Publihsher has been tested with Apache Tomcat 8.x and 9.x:

_images/9-tomcat.png

JasperReportsIntegration

_images/13-jri.png

JRI Publihsher has been tested with JasperReportsIntegration 2.5.1 and 2.6.2:

_images/14-jri.png

Note

If you wish to use a Beta version of JasperReporsIntegration, tick the “Show Beta Versions” select box

JNDI Entries

JRI Publihsher allows you to add JNDI templates, and associated JARS for PostgreSQL, MySQL, and MSSQL as shown below:

_static/JRI-JNDI.png

The JNDI entries are optional.

Note

JNDI entries are created at /home/tomcat/tomcat-version/conf/context.xml

The JNDI elements added are shown below. These defaults and must be edited with your own host, username, etc…

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
 <Resource name="jdbc/postgres" auth="Container" type="javax.sql.DataSource"
 driverClassName="org.postgresql.Driver"
 maxTotal="20" initialSize="0" minIdle="0" maxIdle="8"
 maxWaitMillis="10000" timeBetweenEvictionRunsMillis="30000"
 minEvictableIdleTimeMillis="60000" testWhileIdle="true"
 validationQuery="select user" maxAge="600000"
 rollbackOnReturn="true"
 url="jdbc:postgresql://localhost:5432/xxx"
 username="xxx"
 password="xxx"
 />

 <Resource name="jdbc/MySQL" auth="Container" type="javax.sql.DataSource"
 maxTotal="100" maxIdle="30" maxWaitMillis="10000"
 driverClassName="com.mysql.jdbc.Driver"
 username="xxx" password="xxx"  url="jdbc:mysql://localhost:3306/xxx"/>

 <Resource name="jdbc/MSSQL" auth="Container" type="javax.sql.DataSource"
 maxTotal="100" maxIdle="30" maxWaitMillis="10000"
 driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver"
 username="xxx" password="xxx"  url="jdbc:sqlserver://localhost:1433;databaseName=xxx"/>

Completing Installation

Once each step of the Wizard is completed, the Wizard can be removed:

_images/19-donei.png

With the Wizard completed, your module should appear as below:

_images/JRI-Publisher-Main.png

Note

The JRI application is deployed at this point. You can proceed to create data sources, publish reports, etc..

About Haveged

Haveged is an entropy generator that will provide markedly faster JVM startup times. The caveat is that it will use much higher CPU load (although for shorter duration due to decreased JVM start up time). Bear this in mind if deploying on VM with limited CPU or other critical applications.

Webmin

Webmin can be accessed via:

https://yourdomain.com:10000

General

Edit Config

_images/config-tab.png

The Config tab is used to edit the following files:

application.properties
server.xml
web.xml
context.xml
tomcat-users.xml
setenv.sh

These files can, of course, be edited via the file system or VI as well.

Apps

_images/apps-tab.png

The Apps manager allows you to deploy, undeploy, and redeploy WAR files in Apache Tomcat

Libraries

_images/libs-tab.png

The Libraries tab is for managing Jar files under:

/home/tomcat/<tomcat-version>/libs

These files can, of course, via the file system.

Note

The advantage of the Libraries tab is that it tracks Jar files installed, This allows you to easily roll back changes.

Java

_images/java-tab.png

The Java tab is used during installation as well as for updating of JDK.

It can also be used to un-install the selected JDK and replace it with a new version.

_images/java-installed.png

Note

When installing or removing, there is an option to set as System default.

Proxy

By default, JRI Publisher enables a Proxy for Apache and maps port 8080 to 80.

This enables you to reach reports via http://yourdomain.com/JasperReportsIntegration without need to add the 8080 port.

Warning

While the proxy is convenient for development or intranet use, in production you should remove the proxy. To remove the Proxy, follow the steps below:

To edit, remove, or update Proxies, click on the Proxy tab as shown below.

_images/proxy.png

Select the default Proxy of / as shown below, and click Remove.

_images/proxy-remove.png

Apache Tomcat

Layout

For installations done using the Wizard, the Apache Tomcat (CATALINA) home directory is:

/home/tomcat/apache-tomcat-v/

Where apache-tomcat-v is the version you chose to install.

The CATALINA_HOME variable is set both in the Tomcat init script as well as setenv.sh files.

JRI File Locations

For JasperReportsIntegration layout and customization options, please see the Jasper section below.

Starting and Stopping

There are two ways to start/stop/restart Tomcat.

  1. Via Module, using the Stop/Start/Restart buttons as shown below:
_images/tomcat-tab1.gif
  1. Via SSH, using the following commands
1
 /etc/init.d/tomcat { start | stop | restart | status }

Init Script

The Tomcat init script is located in /etc/init.d and has the following content.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
     #!/bin/bash
     ### BEGIN INIT INFO
     # Provides:        tomcat
     # Required-Start:  $network
     # Required-Stop:   $network
     # Default-Start:   2 3 4 5
     # Default-Stop:    0 1 6
     # Short-Description: Start/Stop Tomcat server
     ### END INIT INFO

     # Source function library.
     . /etc/environment;     #Catalina variables
     . $CATALINA_HOME/bin/setenv.sh

     RETVAL=$?

     function start(){
     echo "Starting Tomcat"
     /bin/su - tomcat $CATALINA_HOME/bin/startup.sh
     RETVAL=$?
     }

     function stop(){
     echo "Stopping Tomcat"
     /bin/su - tomcat -c "$CATALINA_HOME/bin/shutdown.sh 60 -force"
     RETVAL=$?
     }

     case "$1" in
     start)
             start;
     ;;
     stop)
             stop;
     ;;
     restart)
             echo "Restarting Tomcat"
     stop;
             start;
     ;;
     status)

             if [ -f "${CATALINA_PID}" ]; then
                     TOMCAT_PID=$(cat "${CATALINA_PID}")
                     echo "Tomcat is running with PID ${TOMCAT_PID}";
                     RETVAL=1
             else
                     echo "Tomcat is not running";
                     RETVAL=0
             fi
             ;;
     *)
     echo $"Usage: $0 {start|stop|restart|status}"
     exit 1
     ;;
     esac
     exit $RETVAL

Version

JRI Publisher has been tested with Tomcat 9.x

Data Sources

Data Source Types

Data Sources are used to connect your Oracle database.

JRI Publisher supports both JDBC and JNDI Data Source types included with JRI.

JDBC Data Sources are stored in a flat file at:

${CATALINA_HOME}/jasper_reports/conf/

JDBC Data Sources have the following form:

#====================================================================
# JDBC datasource configuration
# http://www.orafaq.com/wiki/JDBC#Thin_driver
# additional jdbc configurations, please uncomment
#====================================================================
[datasource:test]
name=test
url=jdbc:oracle:thin:@127.0.0.1:1521:XE
username=my_oracle_user
password=my_oracle_user_pwd

JNDI Data Sources are stored in a database and referenced in the application server rather than stored in a flat file as with JDBC Data Sources.

JNDI Data Sources have the following form:

#====================================================================
# Native JNDI datasource, to be configured in the application server
# name: jndi_test
#====================================================================
[datasource:jndi_test]
type=jndi
name=jndi_test

Working with Data Sources

Data Sources can be added, edited and removed from the JRI Publisher Module via the Data Source tab, as shown below

_images/data-source-tab.png

The default view on clicking the tab is the List view, as shown below.

_images/data-source-default.png

To add a Data Source, click on the Add tab at top.

Select the desired Data Source type and enter the required information as shown below. Then click the Add button:

_images/add-data-source.png

On the main Data Source tab we can confirm the Data Source has been added:

_images/data-source-added-ok.png

To remove a Data Source, click on the Remove tab and select the Data Source you wish to remove using the drop-down selector as shown below:

_images/data-source-remove.png

Publish

Publishing Reports

To publish a report, click the Publish tab as shown below:

_images/publish-tab.png

This will open the screen below.

_images/publish-default.png

Note

The file browser location is set to /home/tomcat/apache-tomcat-v/jasper_reports/reports

Select the directory you wish to publish to and then select Upload to upload both your .jrxml and .jasper files.

You would also include any support files, such as image files.

Creating Directories

To publish a report, click the Publish tab as shown below.

_images/publish-tab.png

Enter the name of the directory you wish to create as show below. This will create a new directory, NewReports, under the main reports directory.

Once text is entered, upload any files you wish to.

_images/publish-browse.png

Note that once a Directory has been created, it will be added to the availbale directories for subsequent publications:

_images/publish-new.png

Options

There are four options for uploading files.

  1. Local File - this is a file already on the device.
  2. Uploaded File - upload from your local machine.
  3. HTTP or FTP URL - obtain files via HTTP or FTP

Additionally, select the options to upload zip archives as well as to over-write any existing files (for when you publish updates to your reports).

_images/publish-options.png

Schedule

Scheduling Reports

Reports can be scheduled with a variety of options via the Schedule tab as shown below:

_images/schedule-tab.png

On the main Schedule page, click the Add tab to open the Create Schedule page as shown below.

_images/schedule-new.png

Scheduling Options

The Schedule module offers the following options.

Execute:

Options:
   now
   custom
   hourly
   weekly
   monthly

now: This will run the report immediately, with no subsequent runs.

custom: This option allows you to enter a custom cron for running the report

hourly, weekly, and monthly are as stated.

Name:

Options:
   Drop-down list of all available reports

The Name field will display a list of all available reports. Above, we have select the NewReports/ClassReports we created earlier.

Format:

Options:
   csv
   docx
   html
   html2
   jxl
   pdf
   pptx
   rtf
   xls
   xlsx

Select the desired output format for the report.

Data Source:

Options:
   Displays a drop-down list of Data Sources you have created.

Select the desired Data Source for the report.

File Name:

Options:
   Enter the desired file name WITH Extension.
   Example: ClassReports.pdf

Enter the desired Data Source for the report.

Email:

Options:
   Enter email address or comma separated list of addresses for delivery.

Enter the desired Data Source for the report.

Note

If you do not wish to email the report, tick the “Don’t send email” box. This will run the report and save it to disk on the server. The report can be retrived via disk or downloaded via Reports tab.

Optional Params

The Optional Params tab allows you to:

  1. Set email subject
  2. Set email message
  3. Use Email HTML Template
  4. Add report parameters

Email Templates

You can use HTML Email Templates you created by selecting the desired template from the drop-down list as shown below.

_images/use-email-template.png

Note

Be sure to check the “Use template” box when using an HTML Template.

URL Parameters

To add a Report Parameter to the report URL, enter the variable in the left box and the value in the right box as shown below:

_images/schedule-params.png

Click the Save button.

_images/schedule-optional-params.png

You can add as many parameters as you wish to.

Finally, click the Creat button to schedule the report.

Additional Examples

Below are some additional examples.

Send report every Tuesday at 1500 (3 PM)

_images/schedule-tuesdays.png

Send report every hour without email delivery

_images/schedule-hour.png

Send report weekly with StudentID = 51

_images/schedule-weekly.png

Email Templates

Overview

Click the Templates tab to open the Email Templates.

_images/templates-tab.png

This will open the screen below.

_images/email-templates.png

Template Layout

The default template is Lee Munroe’s Responsive Email Template:

https://github.com/leemunroe/responsive-html-email-template

Create a Template

To create a new Template, enter the name of the new template and clicking Create as shown below:

_images/create-template.png

Note

You must include the .html file extension in the name of the template you create.

The new template you created will now will be loaded into the editor as shown below:

_images/create-template-2.png

Perform your edits and click the Preview Template link as shown below:

_images/create-template-3.png

To return to the Editor, click the return link as shown below:

_images/create-template-4.png

Note

The Preview Template function is basic and it is best to run your HTML code to confirm and check your work.

Once you are happy with the template, click the Save button.

Link to edit the Schedule for the report

Using Templates

Templates are assigned by you during schedule creation.

You can use a single template on multiple schedules.

Report Dashboard

Overview

Click the Reports tab to open the Reports Dashboard.

_images/reports-tab.png

This will open the screen below.

_images/report-dashboard.png

As we can see above, the creation of our NewReports Directory has been added to the directory structure. This is true for all directories and sub directories added.

Dashboard Layout

Expanding the NewReports directory, we see below:

_images/report-dashboard-item.png

Dashboard Functions

Name:

Clicking on the report name will open the .jrxml file for editing, as shown below:
_images/reports-edit-jrxml.png

Actions:

Run: Runs the report on demand.

_images/reports-actions.gif

Clean: Opens a new window to delete any reports you may wish to delete

_images/reports-cleaner.png

Download: Opens a new window to download selected report(s) in .zip or .bgz format.

_images/reports-downloader.png

SchID:

Link to edit the Schedule for the report

Cron:

Displays the cron in use for the Schedule

Format:

Displays the report format (e.g. pdf, csv, etc…)

Data Source:

Displays report Data Source

Output:

Clicking the Browse button will open the report directory in the File Manager as shown below:

_images/reports-browse.png

Email:

Displays report email recipient(s).

Optional Params:

Displays any URL Parameters the report is using.

No Schedule

Note

Any report that does not have a schedule will show the Scheduler icon in the Actions menu. To add a Schedule, click the icon as shown below.

_images/reports-no-schedule.png

Security Monitor

Overview

Click the Security tab to open the Security Checks page.

_images/security-tab.png

This will open the screen below.

_images/security-panel.png

Checks

The security page evaluates five checks and provides fixes if check fails.

  • Firewalld status
  • InfoPage status
  • Demo directory status
  • Password encryption status
  • ipAddressesAllowed status

Fixing Security Issues

Whether or not you elect to fix an issue is up to you.

To fix a security issue, simply click the “Fix Now” button as shown.

_images/fix.png

Firewalld

It’s important to limit the IPs that have access to your JRI instance to the database(s) being served.

InfoPage

The info page shows important information and should be disabled.

Clicking the Fix Now button will disable the page in your application.properties file.

Demo Directory

The demo directory should be deleted in production environments.

Password Encryption

Clicking the button will encrypt all un-encrypted passwords in your application.properties file.

Whenever a new password is added via a Data Source, you can encrypt via this location.

Note

You may see an error displayed: ERROR StatusLogger No log4j2 configuration file found. Using default configuration… The error is due to configuration and does not effect encryption.

ipAddressesAllowed

Restrict access to JRI based on IP address

Note

Each time a Data Source password is added via the Data Source tab, you will see the status for password encryption change.

Please see https://github.com/daust/JasperReportsIntegration#security for additional information.

Jasper

JasperReportsIntegration

The information below pertains to the deployment of JasperReportsIntegration in JRI Publisher. For full documentation of JasperReportsIntegration, please see http://www.opal-consulting.de/downloads/free_tools/JasperReportsIntegration/

File Locations

On installation, the JRI files are saved to:

/home/tomcat/apache-tomcat-v/jasper_reports

Here, you will find the following:

/home/tomcat/apache-tomcat-v/jasper_reports/conf

/home/tomcat/apache-tomcat-v/jasper_reports/schedules

/home/tomcat/apache-tomcat-v/jasper_reports/reports

/home/tomcat/apache-tomcat-v/jasper_reports/logs

** reports ** contains your Jasper report files.

** conf ** contains the application.properties file

** schedules ** contains the .sh files for the Scheduler

Gen Script

The Report Scheduler script is located under /etc/init.d/gen_jri_report.sh and can be customized to suit and extend your requirements.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
     #!/bin/bash -e

     source /etc/environment

     JRI_HOME="${CATALINA_HOME}/jasper_reports/"

     #source the report environment
     source "${JRI_HOME}/schedules/${1}_env.sh"

     DONT_MAIL="${2}"

     #set who is sending the mail
     export EMAIL='root@localhost'
     REPORT_FOLDER=$(dirname ${REP_ID})

     #encode the / in report id
     REP_ID=$(echo "${REP_ID}" | sed 's/\//%2F/g')

     if [ "${OPT_PARAMS}" ]; then
     OPT_PARAMS="&${OPT_PARAMS}"
     fi

     URL="http://localhost:8080/JasperReportsIntegration/report?_repName=${REP_ID}&_repFormat=${REP_FORMAT}& _dataSource=${REP_DATASOURCE}&_outFilename=${REP_FILE}${OPT_PARAMS}"

     TSTAMP=$(date '+%Y%m%d_%H%M%S')
     REP_FILEPATH="${JRI_HOME}/reports/${REPORT_FOLDER}/${TSTAMP}_${REP_FILE}"

     wget -O"${REP_FILEPATH}" "${URL}"
     if [ $? -ne 0 ]; then
     rm -f "${REP_FILEPATH}"
     fi

JRI Module Files

On installation, the JRI Module files are saved to:

/usr/libexec/webmin/jri_publisher (CentOS)
/usr/share/webmin/jri_publisher (Ubuntu)

The JRI Module configuration files are located at /etc/webmin/jri_publisher:

/etc/webmin/jri_publisher/config
/etc/webmin/jri_publisher/openjdk_version_cache
/etc/webmin/jri_publisher/oracle_version_cache

reports contains your Jasper report files.

conf contains the application.properties file

schedules contains the .sh files for the Scheduler

Version

The JasperReportsIntegration version is the one selected while using the install Wizard.

Schedule Files

Each schedule creates a numeric file under:

/home/tomcat/apache-tomcat-version/jasper_reports/schedules

The file has the following structure:

1
2
3
4
5
6
7
8
9
REP_FORMAT=pdf
REP_ID=NewReports/StateInfo
OPT_PARAMS="StateID=51"
REP_DATASOURCE="Demo DS"
EMAIL_SUBJ="State Report"
REP_FILE=State-Info.pdf
EMAIL_BODY="Please find the State Reports attached."
SCH_ID=12
RECP_EMAIL=user@company.com

The above parameters are passed to the Jasper url as well as to MUTT for email delivery.

MUTT Parameters

JRI Publisher uses MUTT in conjuction with Postfix to deliver reports via email.

The final input has the form:

./etc/init.d/gen_jri_report.sh schedules.{1}

Where schedules.{1} is passed to gen_jri_report.sh

CSS

The screenshots in the documentation use a Material Design CSS Extension we created.

The Material Design CSS, as well as a logo, are added during installation.

To remove these, simply delete below from /etc/webmin/authentic-theme/ directory

style.css

logo_welcome.png

In addition to making the screens a bit more vivid, it also increaes the size of objects on the page as well as padding, making it easier to work with

Security

You can use the Security Monitor on your installation to address common security issues.

The above is only meant to address a subset of JRI security areas.

It does not address basic server security such as changing ports, disabling root access, etc…

Note

All Tomcat and JRI services are owned and run by user tomcat with minimal privilages.

Calling Reports

Calling Reports

The information below is a quick start guide to calling reports from non-APEX environments.

Cautions

It is important that the following be observed:

Access to the JRI installation via 8080 must be limited to the web server.

Do not disply the report URL in any way

Example

Below is a basic example of calling Jasper reports via a drop-down using PHP.

The drop-down contains the _reportName parameter, which is passed to the PHP code.

The code then parses the _reportName parameter to create the url.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
     <?php


     if (isset($_GET['report_name'])) {

     $data = array(
             "_repName"=> $_GET['report_name'],
             "_repFormat"=>"pdf",
             "_dataSource"=>"datasource",
             "_outFilename"=>"report.pdf"
     );

     $file = 'http://123.4.5.6:8080/JasperReportsIntegration/report?' . http_build_query($data);

     header("Pragma: public");
     header("Expires: 0");
     header("Content-Type: application/octet-stream");
     header("Cache-Control: must-revalidate, post-check=0, pre-check=0");
     header("Cache-Control: public");
     header("Content-Description: File Transfer");
     header('Content-Disposition: attachment; filename="'. $data['_outFilename'] . '"');
     header("Content-Transfer-Encoding: binary\n");

     readfile($file);
     exit();
     }
     ?>

     <!DOCTYPE html>
     <html>
             <body>
             Report Form
             <br>
             <form action="" method="get">
             <select name="report_name">
                     <option value="student">Student Reports</option>
                     <option value="teacher">Teacher Reports</option>
                     <option value="class">Class Reports</option>
                     <option value="grade">Grade Reports</option>
             </select>
             <button type="submit">Submit</button>
     </form>


     </body>
     </html>

Blocking Port

Be certain that access to port 8080/8443 is open only to the web server.

Project Support

Contributing

We welcome all contributors.

While any code contributions are welcome, areas that could use improvement are:

  • Providing feedback
  • Email Formating
  • iReport Library Updates

Issues

If you’ve found a bug, let us know.

Pull Requests

Create a fork of our repo.

To submit a pull request for a new feature:

  1. Run the tests. Every pull request for a new feature should have an accompanying unit test and docs changes.
  2. Create a new branch off of the master branch for your feature.
  3. Add a test (or multiple tests) for your feature.
  4. Add your new feature.
  5. Push to your fork and submit the pull request.

To submit a bug fix:

  1. Create a new branch off of the master branch.
  2. Add a test that demonstrates the bug.
  3. Make the test pass.
  4. Push to your fork and submit the pull request!

To submit a documentation fix:

  1. Create a new branch off of the master branch.
  2. Add your documentation fixes (no tests required).
  3. Push to your fork and submit the pull request!

Commercial Support

Commercial Support is available via Cited, Inc.

In addition to JRI Publisher, Cited, Inc. also offers a multi-user edition written in PHP.

License

GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

Preamble

The GNU General Public License is a free, copyleft license for

software and other kinds of works.

The licenses for most software and other practical works are designed

to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program–to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not

price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you

these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether

gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps:

(1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers’ and authors’ protection, the GPL clearly explains

that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run

modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents.

States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and

modification follow.

TERMS AND CONDITIONS
  1. Definitions.

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of

works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this

License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work

in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based

on the Program.

To “propagate” a work means to do anything with it that, without

permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other

parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices”

to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

  1. Source Code.

The “source code” for a work means the preferred form of the work

for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official

standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other

than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all

the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users

can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that

same work.

  1. Basic Permissions.

All rights granted under this License are granted for the term of

copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not

convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under

the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

  1. Protecting Users’ Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological

measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid

circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

  1. Conveying Verbatim Copies.

You may convey verbatim copies of the Program’s source code as you

receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey,

and you may offer support or warranty protection for a fee.

  1. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to

produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

a) The work must carry prominent notices stating that you modified it, and giving a relevant date.

b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.

c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.

d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

A compilation of a covered work with other separate and independent

works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

  1. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms

of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.

b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.

c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.

d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.

e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

A separable portion of the object code, whose source code is excluded

from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any

tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods,

procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or

specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a

requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided,

in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

  1. Additional Terms.

“Additional permissions” are terms that supplement the terms of this

License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option

remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you

add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or

b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or

c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or

d) Limiting the use for publicity purposes of names of licensors or authors of the material; or

e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or

f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

All other non-permissive additional terms are considered “further

restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you

must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the

form of a separately written license, or stated as exceptions; the above requirements apply either way.

  1. Termination.

You may not propagate or modify a covered work except as expressly

provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your

license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is

reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the

licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

  1. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or

run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

  1. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically

receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an

organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the

rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

  1. Patents.

A “contributor” is a copyright holder who authorizes use under this

License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims

owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free

patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express

agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license,

and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or

arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within

the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting

any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

  1. No Surrender of Others’ Freedom.

If conditions are imposed on you (whether by court order, agreement or

otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

  1. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have

permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

  1. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of

the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the

Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future

versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different

permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

  1. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY

APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  1. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING

WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

  1. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided

above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

If you develop a new program, and you want it to be of the greatest

possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest

to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

<one line to give the program’s name and a brief idea of what it does.> Copyright (C) <year> <name of author>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short

notice like this when it starts in an interactive mode:

<program> Copyright (C) <year> <name of author> This program comes with ABSOLUTELY NO WARRANTY; for details type `show w’. This is free software, and you are welcome to redistribute it under certain conditions; type `show c’ for details.

The hypothetical commands `show w’ and `show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school,

if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.

The GNU General Public License does not permit incorporating your program

into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>.