# How to start using



# Requirements

Installed and correctly configured **WHMCS**

<p class="callout info">Module tested on **WHMCS** 8.1 version</p>

**NextCloud** server account with **WebDAV** access - this module works properly only with **NextCloud,** for now**.**

<p class="callout warning">The system requires use and has been fully tested with NEXTCLOUD, a recognized opensource software. You can use your own Nextcloud installation or use our free solution available at this link: https://crm.puq.pl/store/za-darmo</p>

For the correct operation of the module, PHP parameters are required:

```shell
PHP >= 7.2
file_uploads On
post_max_size 80M ;(Be guided by the size of the PDF files)
upload_max_filesize 80M ;(Be guided by the size of the PDF files)
max_file_uploads 40
```

# Installation

At this stage, the module does not include a standalone installer.

<p class="callout info">The installation consists in uploading the module files to the appropriate addons directory in the WHMCS installation and then activating the plug-in.</p>

Installation requires basic knowledge. If you are a WHMCS user and you do not have access to the server where WHMCS is installed, you will not be able to install the module.

<p class="callout warning">Access to the server terminal with WHMCS installation or the ability to upload files via FTP is required.</p>

<p class="callout warning">Attention!!! We remind you - for the correct operation of the module you need a WebDAV server / account from NextCloud. Failure to do so makes it impossible to use the system.</p>

PDF files are stored on the **NextCloud** server and cataloged by type and date of the document (date entered in the document, example: date of invoice receipt)

To **install** the module, copy the module folder to the WHMCS **"modules/addons"** folder.

```shell
git clone https://github.com/PUQ-sp-z-o-o/puq_commitments_forecaster.git
cp -r puq_commitments_forecaster WHMCS_DIR/modules/addons
```

or

```shell
wget https://cf.puq.info/whmcs-module/puq_cf_WHMCS-latest.tar.gz
tar -xzvf puq_cf_WHMCS-latest.tar.gz
cp -r puq_commitments_forecaster WHMCS_DIR/modules/addons/
```

# Activation

In the WHMCS administrator panel, browse to:

```shell
System Settings -> Addons Modules
```

Activate the module by clicking the **"Activate"** button in the **"Commitments forecaster"** module.

[![2021-11-03_16-43.png](https://doc.puq.info/uploads/images/gallery/2021-11/scaled-1680-/L642021-11-03-16-43.png)](https://doc.puq.info/uploads/images/gallery/2021-11/L642021-11-03-16-43.png)

Activating the module automatically creates tables in the WHMCS database with the prefix **"puq\_"**

# Deactivation

**Attention!!!**  
Deactivating a module automatically deletes the tables in the database associated with that module.

In the WHMCS administrator panel, browse to:

```
System Settings -> Addons Modules
```

Deactivate the module by clicking the **"Deactivate"** button in the **"Commitments forecaster"** module.

[![2021-11-03_16-44.png](https://doc.puq.info/uploads/images/gallery/2021-11/scaled-1680-/pN02021-11-03-16-44.png)](https://doc.puq.info/uploads/images/gallery/2021-11/pN02021-11-03-16-44.png)

# Configuration of module parameters

In the WHMCS administrator panel, browse to:

```
System Settings -> Addons Modules -> Commitments forecaster
```

Click the **"Configure"** button

[![2021-11-03_16-44.png](https://doc.puq.info/uploads/images/gallery/2021-11/scaled-1680-/pN02021-11-03-16-44.png)](https://doc.puq.info/uploads/images/gallery/2021-11/pN02021-11-03-16-44.png)

Enter your NextCloud server login details:

**WebDAV URL HTTPS://** - {SERVER}/remote.php/dav/files/{USER}/  
**Note:** link without **"https: //"** and at the end **"/"**  
**WebDAV user**  
**WebDAV password**  
**Access Control -** select the user groups that must have access to the module.

[![2021-11-03_16-47.png](https://doc.puq.info/uploads/images/gallery/2021-11/scaled-1680-/BUU2021-11-03-16-47.png)](https://doc.puq.info/uploads/images/gallery/2021-11/BUU2021-11-03-16-47.png)

After entering all the data, click the "Save Changes" button

