Deployment On-Premises

If you are using the OC Reporter application in the Octopus Cloud, you can skip this chapter.

Requirements

To ensure OC Reporter operates correctly, the server on which you install the application must meet the requirements shown below.

Hardware Requirements

Software Requirements

Network Requirements

Installation

The installation for OC Reporter requires an IIS web server on Windows. Download the OC Reporter installation package and execute the following installations steps for OC Reporter:

1. Create a folder on the server, where you want to deploy OC Reporter. By convention, we recommend creating a folder C:\inetpub\oc_reporter.
2. Extract the installation files into the C:\inetpub\oc_reporter folder.
3. The next step is to create an OC Reporter IIS website.
4. Open the IIS Manager on the machine where you want to install OC Reporter.
5. In IIS Manager, select Add new website.
6. Enter in Site name the value OC Reporter
7. For Physical path select the folder app\public of the OC Reporter installation, e.g. C:\inetpub\oc_reporter\app\public
8. In the Binding section, you define the endpoint URL for OC Reporter. Choose the binding Type and the Port.
9. Click OK to add the new website.
10. Once the OC Reporter IIS website is created, you need to assign the appropriate permissions to the C:\inetpub\oc_reporter folder.
11. Right-click the C:\inetpub\oc_reporter folder and select Security.
12. Give the IUSR user full control to this folder and its subfolders.
13. Install PHP 8.1 x64 (or higher), from the official repositories/files for PHP for Windows X64 NTS.
14. Install MariaDB 10.11 LTS x64 for Windows, and note the MariaDB root password.
15. Set-up PHP FastCGI and Handler mappings under the OC Reporter website. PHP Handler mapping should point to the correct PHP script path (*.php), and php-cgi.exe path for the installed PHP version, and should be set with the following PHP script verbs: GET,HEAD,POST,PUT,DELETE. PHP CGI (FastCGI) configuration should point to the relevant php-cgi.exe path, as per the installed PHP version. Additional FastCGI parameters to be set: instanceMaxRequests (10000), ActivityTimeout (7200), RequestTimeout (7200). Add a 'Default Document' parameter on the IIS web server GUI, and set its value to Index.php (required so that IIS can load default index files of PHP applications).
16. When PHP, and MariaDB are installed, open the C:\inetpub\oc_reporter\app\public folder and locate the octopus.onprem.json file.
17. Rename octopus.onprem.json to octopus.json.
18. Open the octopus.json file with Notepad++ or a similar editor. You can download Notepad++ from this website.
19. In the octopus.json file, change the following parameters:

    1. In app.tenant, enter your OCID.

    2. In app.tenant_access_token, enter your access token.

    3. In cronjob.key, define the cronjob key. This can be any key, enter, for example, octo99. The cronjob key is used only for the OC Reporter software catalog update process.

    4. To configure the email function of OC Reporter to send notifications and reports automatically, you need to add in app.email a “from” email address for OC Reporter.

    5. If a virtual host is configured on the IIS and DNS is configured in the network, in app.baseUrl, enter the DNS hostname/virtual host of the OC Reporter IIS website. That entry is primarily used for the URLs shared in the emails sent by the OC Reporter application.

    6. Enter your database connection details under the section db:

       1. In dns section ****enter for host= the IP address of the database server. ****Usually it is the localhost IP address 127.0.0.1.
       2. In dns section enter for dbname= the value oc_reporter.
       3. Enter in username the value root, or the username you created for the database.
       4. Enter in password the password of the user to access the database.
       5. The database name and credentials need to be the same as the ones you will use for the database server.

    7. If an email server is available and you want to use the email functionality, in the mailer section, enter the following values:

       1. Enter in the transport section to host the SMTP/email relay IP address/FQDN.

       2. Enter the username and password, if needed for the authentication. If not, remove the username and password rows entirely.

       3. If you are using a special port, enter it in the port section. If you are using standard SMTP enter 25 for the port, or another port number if custom ports are configured.

       4. If encryption is used, enter that value in the encryption section. Usually, it is the value ssl or tls. If no encryption is used, remove that row entirely.

       5. Please ensure that the last item in the transport section does end with a comma.

          NOT

    8. Save the octopus.json file and close it.

20. The next step is to create an appropriate database and the required tables.
21. Open the command prompt window (cmd.exe) and run the following command:
22. mysql -u root -p
23. Enter the root database password, you created in the installation process of the database server. You are logged in now in the database server.
24. To create the OC Reporter database, run the following query:
25. CREATE DATABASE oc_reporter CHARACTER SET utf8 COLLATE utf8_general_ci;
26. After the database is created, run the following query to open the database:
27. use oc_reporter;
28. Open now a second command prompt (cmd.exe) window.
29. Enter the following command to change the working folder:
30. cd C:\inetpub\oc_reporter\app
31. To create all the needed tables in the database for the OC Reporter application, run the following command:
32. yii migrate
33. Switch back to the first command prompt, where the database server is still open.
34. Run the following SQL INSERT command to create the first user in the database to login into OC Reporter. Replace the placeholders with their actual correct values. Replace the placeholders with their actual correct values.
35. INSERT INTO user (tenant_id, role_id, first_name, last_name, pref_lang, access_email, access_password_hash, auth_key, status) VALUES ('<OCID>', 'admin', '<Firstname>', '<Lastname>', 'en', '<Email>', '<PasswordHash>', '<AuthKey>', 'active');
36. To make sure the users have been created, run the following query:
37. SELECT * FROM user;
38. To update the OC Reporter software catalog tables, open a web browser and enter:
39. http:// <fqdn-or-ip-of-the-oc-reporter-server> /cronjob/update-software-tables?key=octo99
40. The exact value of this URL depends on how the OC Reporter IIS website was configured.
41. Go back to the database console and run the following query to check if the software catalog gets filled into the table.
42. SELECT * FROM software;
43. Next, you need to make a few PHP configuration changes.
44. Locate the php.ini file of your installed PHP version.
    1. For x86 PHP installation: C:\Program Files (x86)\php[php-version]\php.ini
    2. For x64 PHP installation: C:\Program Files\php[php-version]\php.ini
45. Open the php.ini file in Notepad or another similar text editor. You need to run the text editor as an administrator.
46. Change the memory_limit parameter to 2048M.
47. Change the max_execution_time parameter to 6000.
48. Save and close the php.ini file.
49. You need to create now a regular Windows scheduled task for OC Reporter to execute some processes automatically, such as importing the scanned inventory files of OC Scanners or sending notifications by email.
50. On the machine where you are installing the on-premise OC Reporter, open the Task Scheduler console.
51. In the Task Scheduler console, right-click the blank field and select New task.
52. In the Name field, enter OC Reporter.
53. Select Run whether user is logged on or not and Run with highest privileges.
54. Select the Triggers tab.
55. In the Settings section, select Daily.
56. In Start, select a start date and time. The minutes and seconds values need to be all zeros.
57. In Recur every, enter 1.
58. In the Advanced settings section:
    1. Select Repeat task every and from the list, select 5 minutes.
    2. In for a duration of, from the list, select Indefinitely.
    3. Select Stop task if it runs longer than and from the list, select 12 hours.
    4. Select Enabled.
    5. Click the OK button.
59. Select the Actions tab.
60. From Action, select Start a program.
61. In Program/script, enter C:\inetpub\oc_reporter\app\yii.bat.
62. In Add arguments (optional), enter cronjob.
63. Click the OK button and then again the main OK button.
64. The Task Scheduler console asks you to enter the appropriate domain admin or local admin username and password. Enter the values and click the OK button. You can run the scheduled task also with SYSTEM (LOCALSYSTEM).
65. Installation of OC Reporter is completed.
66. To access the on-premises OC Reporter, you need to open a web browser window and enter the URL of the on-premises OC View. This URL is the IIS Website address you have configured, for example, http://oc-reporter-address:8080. The address can also be an FDQN or IP address of the OC Reporter server with a different port number, depending on how the OC Reporter IIS website is configured.