What is OCS or OCSng?:
In short, OCS (Open Computers and Software Inventory Next Generation) is an assets management and deployment solution.
OCS can be directly integrated with GLPI for seamless asset tracking automation. Check out my other blog post on how to install GLPI
Read more about OCS on their website: OCS
Overview:
In this article, we will go step-by-step on how to install OCS on Ubuntu 21.04. There are a few installation gotchas that I have overcome that are not mentioned in the OCS documentation and I wanted to share this information so that anyone just getting into OCS or wanting to know more about OCS doesn’t have to go through the same pain I had to.
apt-get install -y apache2 build-essential libapache2-mod-php libapache-dbi-perl libarchive-zip-perl libdbd-mysql-perl libdbi-perl libmojolicious-perl libswitch-perl libnet-ip-perl libplack-handler-anyevent-fcgi-perl libsoap-lite-perl libxml-simple-perl make mariadb-client mariadb-server php php-apcu php-bz2 php-cas php-curl php-curl php-gd php-iconv php-imagick php-imap php-intl php-json php-ldap php-mbstring php-memcache php-mysql php-pclzip php-pear php-pspell php-soap php-tidy php-xml php-xmlrpc php-xsl php-zip
cpan install XML::Entities
apt-get update && apt-get upgrade
wget https://github.com/OCSInventory-NG/OCSInventory-ocsreports/releases/download/2.9/OCSNG_UNIX_SERVER-2.9.tar.gz
tar -xvf OCSNG_UNIX_SERVER-2.9.tar.gz
cd OCSNG_UNIX_SERVER-2.9/
sh setup.sh
systemctl enable mariadb && systemctl start mariadb
mysql_secure_installation
mysql -u root -p
create database ocsweb;
CREATE USER 'ocssa'@'localhost' IDENTIFIED BY 'Password12345';
GRANT ALL PRIVILEGES ON ocsweb. * TO 'ocssa'@'localhost' IDENTIFIED BY 'Password12345';
flush privileges;
exit;
vim /etc/php/7.4/apache2/php.ini
post_max_size = 50M
upload_max_filesize = 50M
max_execution_time = 300
max_input_time = 300
memory_limit = 256M
vim /etc/apache2/conf-available/z-ocsinventory-server.conf
# User allowed to connect to database
PerlSetEnv OCS_DB_USER ocssa
# Password for user
PerlSetVar OCS_DB_PWD Password12345
ln -s /etc/apache2/conf-available/ocsinventory-reports.conf /etc/apache2/conf-enabled/ocsinventory-reports.conf
ln -s /etc/apache2/conf-available/z-ocsinventory-server.conf /etc/apache2/conf-enabled/z-ocsinventory-server.conf
ln -s /etc/apache2/conf-available/zz-ocsinventory-restapi.conf /etc/apache2/conf-enabled/zz-ocsinventory-restapi.conf
chown -R www-data:www-data /var/lib/ocsinventory-reports
systemctl restart apache2 && systemctl enable apache2
mv /usr/share/ocsinventory-reports/ocsreports/install.php /usr/share/ocsinventory-reports/ocsreports/install.php.bck
Prerequisites:
- Note: All commands are done via an SSH connection in this guide.
To start you will need to open an SSH session to your Ubuntu machine, if you are on windows you can use putty or even PowerShell to achieve this.
Install the various array of applications and extensions needed to properly run OCS.
apt-get install -y apache2 build-essential libapache2-mod-php libapache-dbi-perl libarchive-zip-perl libdbd-mysql-perl libdbi-perl libmojolicious-perl libswitch-perl libnet-ip-perl libplack-handler-anyevent-fcgi-perl libsoap-lite-perl libxml-simple-perl make mariadb-client mariadb-server php php-apcu php-bz2 php-cas php-curl php-curl php-gd php-iconv php-imagick php-imap php-intl php-json php-ldap php-mbstring php-memcache php-mysql php-pclzip php-pear php-pspell php-soap php-tidy php-xml php-xmlrpc php-xsl php-zip
cpan install XML::Entities
apt-get update && apt-get upgrade
- Command Block #02
- cpan install XML::Entities
- Used primarily for Perl modules, this module deals with the decoding of strings with XML character entities
- cpan install XML::Entities
- Command Block #03
- apt-get update && apt-get upgrade
- && means to run command 2 only if command 1 succedes
- apt-get update && apt-get upgrade
Install OCS Inventory:
Next, install OCS so that certain OCS configuration files will be created and staged. We will configure OCS at a later point in the walkthrough.
wget https://github.com/OCSInventory-NG/OCSInventory-ocsreports/releases/download/2.9/OCSNG_UNIX_SERVER-2.9.tar.gz
tar -xvf OCSNG_UNIX_SERVER-2.9.tar.gz
cd OCSNG_UNIX_SERVER-2.9/
sh setup.sh
+----------------------------------------------------------+
| |
| Welcome to OCS Inventory NG Management server setup ! |
| |
+----------------------------------------------------------+
Trying to determine which OS or Linux distribution you use
+----------------------------------------------------------+
| Checking for Apache web server binaries ! |
+----------------------------------------------------------+
CAUTION: If upgrading Communication server from OCS Inventory NG 1.0 RC2 and
previous, please remove any Apache configuration for Communication Server!
Do you wish to continue ([y]/n)?y
Assuming Communication server 1.0 RC2 or previous is not installed
on this computer.
Starting OCS Inventory NG Management server setup from folder /home/normal/OCSNG_UNIX_SERVER-2.9
Storing log in file /home/normal/OCSNG_UNIX_SERVER-2.9/ocs_server_setup.log
+----------------------------------------------------------+
| Checking for database server properties... |
+----------------------------------------------------------+
Your MySQL client seems to be part of MySQL version 10.5.
Your computer seems to be running MySQL 4.1 or higher, good ;-)
Which host is running database server [localhost] ?
OK, database server is running on host localhost ;-)
On which port is running database server [3306] ?
OK, database server is running on port 3306 ;-)
+----------------------------------------------------------+
| Checking for Apache web server daemon... |
+----------------------------------------------------------+
Where is Apache daemon binary [/usr/sbin/apache2ctl] ?
OK, using Apache daemon /usr/sbin/apache2ctl ;-)
+----------------------------------------------------------+
| Checking for Apache main configuration file... |
+----------------------------------------------------------+
Where is Apache main configuration file [/etc/apache2/apache2.conf] ?
OK, using Apache main configuration file /etc/apache2/apache2.conf ;-)
+----------------------------------------------------------+
| Checking for Apache user account... |
+----------------------------------------------------------+
Which user account is running Apache web server [www-data] ?
OK, Apache is running under user account www-data ;-)
+----------------------------------------------------------+
| Checking for Apache group... |
+----------------------------------------------------------+
Which user group is running Apache web server [www-data] ?
OK, Apache is running under users group www-data ;-)
+----------------------------------------------------------+
| Checking for Apache Include configuration directory... |
+----------------------------------------------------------+
Setup found Apache Include configuration directory in
/etc/apache2/conf-available.
Setup will put OCS Inventory NG Apache configuration in this directory.
Where is Apache Include configuration directory [/etc/apache2/conf-available] ?
OK, Apache Include configuration directory /etc/apache2/conf-available found ;-)
+----------------------------------------------------------+
| Checking for PERL Interpreter... |
+----------------------------------------------------------+
Found PERL interpreter at </usr/bin/perl> ;-)
Where is PERL interpreter binary [/usr/bin/perl] ?
OK, using PERL interpreter /usr/bin/perl ;-)
Do you wish to setup Communication server on this computer ([y]/n)?y
+----------------------------------------------------------+
| Checking for Make utility... |
+----------------------------------------------------------+
OK, Make utility found at </usr/bin/make> ;-)
+----------------------------------------------------------+
| Checking for Apache mod_perl version... |
+----------------------------------------------------------+
Checking for Apache mod_perl version 1.99_22 or higher
Found that mod_perl version 1.99_22 or higher is available.
OK, Apache is using mod_perl version 1.99_22 or higher ;-)
+----------------------------------------------------------+
| Checking for Communication server log directory... |
+----------------------------------------------------------+
Communication server can create detailed logs. This logs can be enabled
by setting integer value of LOGLEVEL to 1 in Administration console
menu Configuration.
Where to put Communication server log directory [/var/log/ocsinventory-server] ?
OK, Communication server will put logs into directory /var/log/ocsinventory-server ;-)
+----------------------------------------------------------------------------+
| Checking for Communication server plugins configuration directory... |
+----------------------------------------------------------------------------+
Communication server need a directory for plugins configuration files.
Where to put Communication server plugins configuration files [/etc/ocsinventory-server/plugins] ?
OK, Communication server will put plugins configuration files into directory /etc/ocsinventory-server/plugins ;-)
+-------------------------------------------------------------------+
| Checking for Communication server plugins perl directory... |
+-------------------------------------------------------------------+
Communication server need a directory for plugins Perl modules files.
Where to put Communication server plugins Perl modules files [/etc/ocsinventory-server/perl] ?
OK, Communication server will put plugins Perl modules files into directory /etc/ocsinventory-server/perl ;-)
+----------------------------------------------------------+
| Checking for required Perl Modules... |
+----------------------------------------------------------+
Checking for DBI PERL module...
Found that PERL module DBI is available.
Checking for Apache::DBI PERL module...
Found that PERL module Apache::DBI is available.
Checking for DBD::mysql PERL module...
Found that PERL module DBD::mysql is available.
Checking for Compress::Zlib PERL module...
Found that PERL module Compress::Zlib is available.
Checking for XML::Simple PERL module...
Found that PERL module XML::Simple is available.
Checking for Net::IP PERL module...
Found that PERL module Net::IP is available.
Checking for Archive::Zip Perl module...
Found that PERL module Archive::Zip is available.
Do you wish to setup Rest API server on this computer ([y]/n)?y
+----------------------------------------------------------+
| Checking for REST API Dependencies ... |
+----------------------------------------------------------+
Found that PERL module Mojolicious::Lite is available.
Found that PERL module Switch is available.
Found that PERL module Plack::Handler is available.
+----------------------------------------------------------+
| Configuring REST API Server files ... |
+----------------------------------------------------------+
Where do you want the API code to be store [/usr/local/share/perl/5.32.1] ?
Copying files to /usr/local/share/perl/5.32.1
+----------------------------------------------------------+
| Configuring REST API Server configuration files ... |
+----------------------------------------------------------+
+----------------------------------------------------------+
| OK, looks good ;-) |
| |
| Configuring Communication server Perl modules... |
+----------------------------------------------------------+
Checking if your kit is complete...
Looks good
Generating a Unix-style Makefile
Writing Makefile for Apache::Ocsinventory
Writing MYMETA.yml and MYMETA.json
+----------------------------------------------------------+
| OK, looks good ;-) |
| |
| Preparing Communication server Perl modules... |
+----------------------------------------------------------+
+----------------------------------------------------------+
| OK, prepare finshed ;-) |
| |
| Installing Communication server Perl modules... |
+----------------------------------------------------------+
+----------------------------------------------------------+
| OK, Communication server Perl modules install finished;-)|
| |
| Creating Communication server log directory... |
+----------------------------------------------------------+
Creating Communication server log directory /var/log/ocsinventory-server.
Fixing Communication server log directory files permissions.
Configuring logrotate for Communication server.
Removing old communication server logrotate file /etc/logrotate.d/ocsinventory-NG
Writing communication server logrotate to file /etc/logrotate.d/ocsinventory-server
+----------------------------------------------------------------------+
| OK, Communication server log directory created ;-) |
| |
| Creating Communication server plugins configuration directory... |
+----------------------------------------------------------------------+
Creating Communication server plugins configuration directory /etc/ocsinventory-server/plugins.
+----------------------------------------------------------------------+
| OK, Communication server plugins configuration directory created ;-) |
| |
| Creating Communication server plugins Perl directory... |
+----------------------------------------------------------------------+
Creating Communication server plugins Perl directory /etc/ocsinventory-server/perl.
+----------------------------------------------------------------------+
| OK, Communication server plugins Perl directory created ;-) |
| |
| Now configuring Apache web server... |
+----------------------------------------------------------------------+
To ensure Apache loads mod_perl before OCS Inventory NG Communication Server,
Setup can name Communication Server Apache configuration file
'z-ocsinventory-server.conf' instead of 'ocsinventory-server.conf'.
Do you allow Setup renaming Communication Server Apache configuration file
to 'z-ocsinventory-server.conf' ([y]/n) ?y
OK, using 'z-ocsinventory-server.conf' as Communication Server Apache configuration file
Removing old communication server configuration to file /etc/apache2/conf-available/ocsinventory.conf
Writing communication server configuration to file /etc/apache2/conf-available/z-ocsinventory-server.conf
+----------------------------------------------------------------------+
| OK, Communication server setup successfully finished ;-) |
| |
| Please, review /etc/apache2/conf-available/z-ocsinventory-server.conf |
| to ensure all is good. Then restart Apache daemon. |
+----------------------------------------------------------------------+
Do you wish to setup Administration Server (Web Administration Console)
on this computer ([y]/n)?y
+----------------------------------------------------------+
| Checking for Administration Server directories... |
+----------------------------------------------------------+
CAUTION: Setup now install files in accordance with Filesystem Hierarchy
Standard. So, no file is installed under Apache root document directory
(Refer to Apache configuration files to locate it).
If you're upgrading from OCS Inventory NG Server 1.01 and previous, YOU
MUST REMOVE (or move) directories 'ocsreports' and 'download' from Apache
root document directory.
If you choose to move directory, YOU MUST MOVE 'download' directory to
Administration Server writable/cache directory (by default
/var/lib/ocsinventory-reports), especially if you use deployment feature.
Do you wish to continue ([y]/n)?y
Assuming directories 'ocsreports' and 'download' removed from
Apache root document directory.
Where to copy Administration Server static files for PHP Web Console
[/usr/share/ocsinventory-reports] ?
OK, using directory /usr/share/ocsinventory-reports to install static files ;-)
Where to create writable/cache directories for deployment packages,
administration console logs, IPDiscover and SNMP [/var/lib/ocsinventory-reports] ?
OK, writable/cache directory is /var/lib/ocsinventory-reports ;-)
+----------------------------------------------------------+
| Checking for required Perl Modules... |
+----------------------------------------------------------+
Checking for DBI PERL module...
Found that PERL module DBI is available.
Checking for DBD::mysql PERL module...
Found that PERL module DBD::mysql is available.
Checking for XML::Simple PERL module...
Found that PERL module XML::Simple is available.
Checking for Net::IP PERL module...
Found that PERL module Net::IP is available.
+----------------------------------------------------------+
| Installing files for Administration server... |
+----------------------------------------------------------+
Creating PHP directory /usr/share/ocsinventory-reports/ocsreports.
Copying PHP files to /usr/share/ocsinventory-reports/ocsreports.
Fixing permissions on directory /usr/share/ocsinventory-reports/ocsreports.
Creating database configuration file /usr/share/ocsinventory-reports/ocsreports/dbconfig.inc.php.
Creating IPDiscover directory /var/lib/ocsinventory-reports/ipd.
Fixing permissions on directory /var/lib/ocsinventory-reports/ipd.
Creating packages directory /var/lib/ocsinventory-reports/download.
Fixing permissions on directory /var/lib/ocsinventory-reports/download.
Creating snmp mibs directory /var/lib/ocsinventory-reports/snmp.
Fixing permissions on directory /var/lib/ocsinventory-reports/snmp.
Creating Administration server log files directory /var/lib/ocsinventory-reports/logs.
Fixing permissions on directory /var/lib/ocsinventory-reports/logs.
Creating Administration server temporary files directory /var/lib/ocsinventory-reports/tmp_dir.
Fixing permissions on directory /var/lib/ocsinventory-reports/tmp_dir.
Creating Administration server scripts log files directory /var/lib/ocsinventory-reports/scripts.
Fixing permissions on directory /var/lib/ocsinventory-reports/scripts.
Configuring IPDISCOVER-UTIL Perl script.
Installing IPDISCOVER-UTIL Perl script.
Fixing permissions on IPDISCOVER-UTIL Perl script.
Writing Administration server configuration to file /etc/apache2/conf-available/ocsinventory-reports.conf
+----------------------------------------------------------------------+
| OK, Administration server installation finished ;-) |
| |
| Please, review /etc/apache2/conf-available/ocsinventory-reports.conf
| to ensure all is good and restart Apache daemon. |
| |
| Then, point your browser to http://server//ocsreports
| to configure database server and create/update schema. |
+----------------------------------------------------------------------+
Setup has created a log file /home/normal/OCSNG_UNIX_SERVER-2.9/ocs_server_setup.log. Please, save this file.
If you encounter error while running OCS Inventory NG Management server,
we can ask you to show us its content !
DON'T FORGET TO RESTART APACHE DAEMON !
Enjoy OCS Inventory NG ;-)
Configure the MariaDB database:
After installing OCS, we will work on configuring the MariaDB database.
systemctl enable mariadb && systemctl start mariadb
mysql_secure_installation
Create a password for the MariaDB root account as the default is nothing, then for the remaining initial setup wizard accept the defaults using “Y“.
NOTE: RUNNING ALL PARTS OF THIS SCRIPT IS RECOMMENDED FOR ALL MariaDB
SERVERS IN PRODUCTION USE! PLEASE READ EACH STEP CAREFULLY!
In order to log into MariaDB to secure it, we'll need the current
password for the root user. If you've just installed MariaDB, and
you haven't set the root password yet, the password will be blank,
so you should just press enter here.
Enter current password for root (enter for none):
OK, successfully used password, moving on...
Setting the root password ensures that nobody can log into the MariaDB
root user without the proper authorisation.
Set root password? [Y/n] Y
New password:
Re-enter new password:
Password updated successfully!
Reloading privilege tables..
... Success!
By default, a MariaDB installation has an anonymous user, allowing anyone
to log into MariaDB without having to have a user account created for
them. This is intended only for testing, and to make the installation
go a bit smoother. You should remove them before moving into a
production environment.
Remove anonymous users? [Y/n] Y
... Success!
Normally, root should only be allowed to connect from 'localhost'. This
ensures that someone cannot guess at the root password from the network.
Disallow root login remotely? [Y/n] Y
... Success!
By default, MariaDB comes with a database named 'test' that anyone can
access. This is also intended only for testing, and should be removed
before moving into a production environment.
Remove test database and access to it? [Y/n] Y
- Dropping test database...
... Success!
- Removing privileges on test database...
... Success!
Reloading the privilege tables will ensure that all changes made so far
will take effect immediately.
Reload privilege tables now? [Y/n] Y
... Success!
Cleaning up...
All done! If you've completed all of the above steps, your MariaDB
installation should now be secure.
Thanks for using MariaDB!
After running through the MariaDB setup wizard, log into the MariaDB management interface.
mysql -u root -p
Prestage a database for OCS as well as assign it a dedicated service account with full permissions. This database & service account will be used later on when it comes to the OCS setup wizard.
The user account and password below are examples and should be adjusted to fit your needs accordingly.
create database ocsweb;
CREATE USER 'ocssa'@'localhost' IDENTIFIED BY 'Password12345';
GRANT ALL PRIVILEGES ON ocsweb. * TO 'ocssa'@'localhost' IDENTIFIED BY 'Password12345';
flush privileges;
exit;
- Command Block #01
- systemctl enable mariadb && systemctl start mariadb
- systemctl is an init system and system manager that has widely become the new standard for Linux distributions
- systemctl enable mariadb tells the MariaDB service to auto-start on boot
- systemctl start mariadb tells the httpdapache service start right now
- systemctl enable mariadb && systemctl start mariadb
Configure Apache Web Server:
After installing the prerequisites we will now work on configuring the HTTPd\Apache webserver.
Edit the PHP “php.ini” to better optimize certain settings for OCS.
# To edit in vim use: i
# To save and quit vim use: Esc + :wq!
vim /etc/php/7.4/apache2/php.ini
Look for the following lines and adjust the settings to better fit your needs. The values below are what I have found to be a good balance when running OCS for small to medium businesses.
post_max_size = 50M
upload_max_filesize = 50M
max_execution_time = 300
max_input_time = 300
memory_limit = 256M
Since we changed the default username and password for OCS we need to update OCS’s configuration files with the database’s service account username and password. (This is also where you would change the database name if you didn’t want to use OCSng’s default “ocsweb” database name.)
# To edit in vim use: i
# To save and quit vim use: Esc + :wq!
vim /etc/apache2/conf-available/z-ocsinventory-server.conf
# Name of database
PerlSetEnv OCS_DB_NAME ocsweb
PerlSetEnv OCS_DB_LOCAL ocsweb
# User allowed to connect to database
PerlSetEnv OCS_DB_USER ocssa
# Password for user
PerlSetVar OCS_DB_PWD Password12345
To have computers be able to communicate with the OCsng server, we will also need to adjust OCS’s API configuration file as well.
# To edit in vim use: i
# To save and quit vim use: Esc + :wq!
vim /etc/apache2/conf-available/zz-ocsinventory-restapi.conf
# Name of database
$ENV{OCS_DB_LOCAL} = 'ocsweb';
# User allowed to connect to database
$ENV{OCS_DB_USER} = 'ocssa';
# Password for user
$ENV{OCS_DB_PWD} = 'Password12345';
Once OCS is installed, it generates Apache configuration files that will need to be enabled by creating alias.
ln -s /etc/apache2/conf-available/ocsinventory-reports.conf /etc/apache2/conf-enabled/ocsinventory-reports.conf
ln -s /etc/apache2/conf-available/z-ocsinventory-server.conf /etc/apache2/conf-enabled/z-ocsinventory-server.conf
ln -s /etc/apache2/conf-available/zz-ocsinventory-restapi.conf /etc/apache2/conf-enabled/zz-ocsinventory-restapi.conf
chown -R www-data:www-data /var/lib/ocsinventory-reports
systemctl restart apache2 && systemctl enable apache2
- Command Block #06
- chown -R
- chown changes the user and/or group ownership of each given file
- -R is used to do it recursively
- www-data:www-data is used to give permission to the apache user and group
- chown -R
- Command Block #07
- systemctl enable apache2 && systemctl start apache2
- systemctl is a system manager that has widely become the new standard for Linux distributions
- systemctl enable apache2 tells the httpdapache service to auto-start on boot
- systemctl start apache2 tells the httpdapache service start right now
- systemctl enable apache2 && systemctl start apache2
Configure OCS:
After installing OCS, prestaging HTTPdApache, and MariaDB, we will now run through the setup wizard to finish setting up the OCS instance.
Browse out to the following: “http://IP-OF-SERVER/ocsreports“, and follow along with the setup wizard to complete the installation and setup of OCS.
Default OCS Login = admin,admin
Clean up:
Rename the “install.php” file in the “OCSReports” directory after the setup wizard is complete or OCS will warn you when you log in.
mv /usr/share/ocsinventory-reports/ocsreports/install.php /usr/share/ocsinventory-reports/ocsreports/install.php.bck
Thoughts?
Thank you for taking the time to read this article, I hope that it was helpful in some way to you. If you noticed anything wrong or have a better way of doing this please don’t hesitate to comment below or send me an email.
Thank you!
Thank you very much for the instructions, was very helpful
If anyone can help me out, no matter what I do, I keep getting the problem listed here below when installing the Windows Agent:
XX.XXX.XXX:80 X.X.X.X – – [19/Oct/2022:21:32:12 +0300] “GET /ocsinventory/deploy/label HTTP/1.1” 404 4031 “-” “OCS-NG_WINDOWS_AGENT_v2.9.2.0”
XX.XXX.XXX:80 X.X.X.X – – [19/Oct/2022:21:32:13 +0300] “POST /ocsinventory HTTP/1.1” 404 4031 “-” “OCS-NG_WINDOWS_AGENT_v2.9.2.0”
And I can’t figure out why. I’ve gone through at least a dozen different articles on installing OCS inventory and I just don’t get it. Any help would be greatly appreciated.
felicidades muy buena guia de ocs . que Dios te Dendiga y te de mas inteligencia y salud.
To get computers to successfully connect to the server, I had to also modify database/user/password for mysql in /etc/apache2/conf-available/zz-ocsinventory-restapi.conf
Worked great, there was one typo in the mysql database creation: should be CREATE USER ‘ocssa’, not ‘oscsa’
create database ocsweb;
CREATE USER ‘oscsa’@’localhost’ IDENTIFIED BY ‘Password12345’;
GRANT ALL PRIVILEGES ON ocsweb. * TO ‘ocssa’@’localhost’ IDENTIFIED BY ‘Password12345’;
Hi Jim, thank you for pointing out this typo and the missing API config. I have updated the post with these changes.
Hi Jim, whilst you change some reference to oscsa, you didn’t change them all (maybe do a find on this page)
Tripped me up!
Hi Andy, thanks for the feed back, sounds like I need to proofread some items across these articles. I’ll see about updating them this weekend.
ok, so I’m one of those who was following the ‘Just Give me the Commands’ link. It’s in there!
Hello everyone,
I have updated the documented and corrected the mistakes. Thank you all for letting me know 🙂