Yo!rent kit installation guide

1. Installation instructions

Please contact the Project Manager of Fatbit who will provide you with the link to download the latest version of Yo!Rent (scripts with installation instructions). This link will download the compressed archive in zip format. This zip file contains -

  • ‘scripts.zip’ file [Yo!rent scripts files]: It contains all the project files that are to be uploaded on a web server.

  • ‘license.txt’ file [Generally shared via mail/Bizixx system]: It contains the license required to access our scripts on your site.

  • ‘readme.txt’ file: It contains the contents provided and how to successfully install our script files.

  • ‘software-requirements.txt’ file: This file lists all the system requirements.

  • ‘server-requirements.php’ file: This file is used to ensure that the server meets the basic software requirements.

  • ‘.htaccess’ file: This file is used for script configuration by following Option 2.

  • ‘Library-files.zip’ file: Place library files ‘core directory’ to {YOUR_WEBROOT}/library.

1.1 Server Verification

Steps to be followed to verify software requirements.

  • Upload the ‘server-requirements.php’ to the web root and open {YOUR_WEBROOT}/server-requirements.php in the browser to make sure that the server meets the basic software requirements. We have created this script to check the maximum of the requirements reliably but some of the settings cannot be detected accurately via a PHP script. So, you can go with your knowledge about the server.

Apache should have mode_rewrite enabled. Sometimes it is not detected accurately by the scripts. After checking it, please make sure to remove this file for your security.

1.2 Scripts Configuration

Please follow the below steps to configure scripts on your Server.

  • Option 1: Set webroot to ‘/public’ directory in the provided scripts [Recommended]

OR

  • Option 2: Set webroot to ‘/public_html’ directory and place all the script files including .htaccess file.

  • Please upload the installation script files to their hosting root directory. By using any FTP, you will connect to the hosting account.

For example: If webroot is configured to /public_html and you have uploaded scripts files to the /public_html then you can access their script files directly via their domain name http://example.com.

  • After uploading the files, you will see the following list of files and folders under their hosting account folder.

  • The ‘license.txt’ file will be provided by the Project Manager of Fatbit which needs to be placed in the ‘Library’ folder provided in the (Root Folder).

  • You can review system configurations under /conf/conf-common.php as per your requirements.

For Example: You can change the value of CONF_UPLOADS_PATH in /conf/conf-common.php to your preference. It is used to store user uploaded files. By default it is set to ‘/user-uploads’ in the scripts. This setting is fine if you are using single instance deployment. If you are using multiple instances behind a load balancer, the value must point to some shared directory which is accessible from all the instances.

  • Write permission to specific directories. The following directory must be writable by PHP/apache:

  • /user-uploads (or the path that you set for CONF_UPLOADS_PATH if you changed it).

  • /public/cache (used for system caching).

  • Now, please open the browser and access your hosting account via your domain name. This should direct you to the installation page.

2. Install the Yo!Rent Kit

There are FIVE important steps to be followed to install Yo!Rent.

Step 1: Setup Guidelines

  • The user must read the guidelines carefully and then click on the ‘Let’s Go’ button.

Step 2: Pre-Installation

  • The user must check if the server is set up correctly or not. Please make sure that the statuses for all PHP settings are On/Active.

  • When installing Yo!Rent on a localhost, the ‘Ioncube’ settings will be marked as Off/Inactive. To install ionCube, please follow the steps provided in Section 4.

  • Please scroll down to check all that the statuses of all files and directories are active/writable. Now, click on the ‘Continue’ button.



Step 3: Configuration

  • In this step, the administration and database related details are to be filled.



The user must enter the database details in the provided input fields. Select ‘Blank Copy Setup’ to install a blank Yo!Rent kit (recommended for production) OR select ‘Setup with Dummy Data (recommended for testing only)’ to install the Yo!Rent kit with dummy data. The dummy data can be used for reference purposes.

Click on ‘Continue’ to proceed to the next step.

Step 4: Create Admin Account

  • In this step, the user needs to enter account and store related details.

Please note that the ‘Username’ and ‘Password’ entered here will be used as login credentials by the user.

Step 5: Finished

  • Please wait until the data is being imported. It might take some time. Once the data is imported, the user will be redirected to the final step.

  • It is recommended to delete the ‘Install’ directory for security reasons, please go to the yorent (Root Folder) > public > install.

  • Clicking on the ‘Access Your Admin Area’ will redirect the user to the login form.



  • Clicking on the ‘Visit Website’ will redirect the user to the website URL at front-end.

  • Create Mysql procedures: Open the following url:

‘{Your_Webroot}/admin/admin-users/create-procedures’

The ‘Created All the Procedures’ message will be displayed.

  • Update System Dependencies: Run command ‘composer update’ at root of the project to update composer and fetch all dependent libraries.

  • Now you can go to configurations ‘{Your_Webroot}/admin/configurations’ in the backend and make the changes as per your preferences.

3. Install Yo!Rent on Localhost

Follow the below instructions before installing the kit on localhost.

I. Download and Install XAMPP on Windows

  • Launch the downloaded XAMPP installer file.

  • Some antivirus applications might interfere in the XAMPP installation process. So it is recommended to stop your antivirus application during the installation procedure. After you have stopped the antivirus, select Yes to continue.

  • Confirm that you will avoid installing the software to C:\Program Files and press OK. User Account Control (UAC) might block some XAMPP functions when installing to C:\Program Files, so it is recommended to install XAMPP to the default folder.

  • Click Next to start the procedure.

  • Select all components and then click Next.

  • Select the folder to install XAMPP and click Next. It is recommended to install the software into the default folder.

  • Untick the ‘Learn more’ about Bitnami for XAMPP checkbox and click Next.

  • Click Next to launch the installation.



  • Check that the ‘Do you want to start the Control Panel now?’ checkbox is ticked and click Finish.

  • After launching XAMPP Control Panel select Config to open XAMPP settings.

Green background around Apache and MySQL marks that these modules work correctly.

  • Open a browser and enter ‘localhost’ in the address line. If you see the Welcome to XAMPP for Windows! notification, the environment is set up and ready for work.

II. Create a Root Folder in XAMPP

  • Open the htdocs folder of the XAMPP installation (by default it’s C:\xampp\htdocs) and create a root new folder named ‘yorent’ (This name is taken to avoid any confusions). The user can choose a different name. However, please make sure to enter the correct folder name in the steps ahead).

  • Please note that by default the XAMPP is installed in the C drive. However, the users can change the path/location during the time of installation. The steps followed in this manual consider the default path/location i.e. C drive.

  • Extract the downloaded Yo!Rent scripts in this folder.

  • Enter localhost/yorent (or Name of the Root Folder created above in Step ii) in the address bar of the browser which will redirect the user to the installation page.

4. IonCube Loader

The status of ionCube is turned off/inactive, the next step is to configure ionCube.

  1. To configure ionCube please visit http://www.ioncube.com/loaders.php

  2. Download the loader wizard zip file as per the windows architecture (32 or 64 bit) being used on user’s system.

  1. Extract the zip file loader-wizard in the system.

  2. Copy and paste the loader-wizard.php file in the folder ‘yorent’ (or created root folder).

  3. Hit the URL: http://localhost/yorent/loader-wizard.php which will open the page Please make sure to enter the correct URL with the name of your root folder (replace ‘yorent’ with your root folder name).

  1. Now go to the ionCube folder that includes several files as shown below.



Copy the file ‘ioncude_loader_win_<PHPversion>.dll’ as per the PHP version being used by the user and paste it in the XAMPP > php > ext folder.

  1. Go to XAMPP > php and open php.ini file with notepad. Now, copy the code line zend_extension = "C:\xampp\php\ext\ioncube_loader_win_7.4.dll" and paste it in the php.ini file on the top.

Please note that this code line includes the file name selected as per the above example. The format to be used in this code line is -

zend_extension = "C:\xampp\php\ext\<FILE NAME>"

  1. Save the changes and restart Apache (Stop and Start) from the XAMPP control panel.

  2. Now, hit the URL: http://localhost/yorent/loader-wizard.php which will display the following message. Please make sure to enter the URL with the name of your root folder (replace ‘yorent’ with root folder name).

  1. Now, refresh the localhost/yorent page which will display the status of IonCube as Active. Please make sure to enter the URL with the name of your root folder (replace ‘yorent’ with root folder name).

-- XX --