Installation Guide

Overview.

To install the script onto your server you have to perform the following steps:

  •     Download the script package from your phpListings.com client panel.
  •     Extract the files to your local computer.
  •     Transfer the extracted files to your hosting server via FTP.
  •     Modify file and directory permissions.
  •     Create a new MySQL database or use an existing one.
  •     Upload the database dump.
  •     Alter script configuration files to include your license key and database credentials.
  •     Open the script administrator panel and perform final configuration steps to secure your installation.

 

Downloading The Package.

You can download the software installation package from your phpListings.com client panel. An active software license is required. There is a separate download link for each license. Click the "Manage" button next to the license you want to download the package for. On the license page click the "Download" button in the "Download" section. Make sure to save the file to your local folder when browser download notification window appears. If your download access has expired, the link is not available and a license extension service must be purchased to access the software installation package.

 

Extracting Files.

The downloaded software files are compressed using ZIP archiver. You have to extract (unzip) the package files to your local folder. We recommend to create a new folder for the extracted files. Most of modern operating systems have built-in support for ZIP archives. Please consult your OS manual on how to extract an archive into a folder.

 

Transferring Files.

We recommend to upload the extracted files to your server using FTP protocol and Filezilla - free multi-platform FTP client. Please consult the Filezilla manual on how to upload files from your local folder to your webserver.

The uncompressed package has three main directories: "app", "public" and "vendor".

The content of the "public" folder have to be uploaded to your webserver web root directory. Web root directory is publicly accessible on the Internet. Usually it contains index.php or index.html placeholder files.

"app", "vendor" directories and the files located in the package root have to be upoaded to the directory one level above the web root to secure the framework and the user uploaded files.

 

File Permissions.

After you have all the files uploaded via FTP you need to alter some of the directory and file permissions on the server to allow the php user access those for writing. We recommend to use Filezilla or your favorite FTP client to manage file permissions.

The following directories have to be writable:

/app/Cache

/app/Exports

/app/Imports

/app/Imports/Logs

/app/Imports/Temp

/app/Sessions

/app/Storage

/app/Storage/Large

/app/Storage/Medium

/app/Storage/Small

/public/sitemap/categories

/public/sitemap/listings

/public/sitemap/locations

/public/sitemap/pages

/public/sitemap/types

Usually -rwxrwxr-x (CHMOD 775) is a good choice. But we recommend to consult your hosting service manual on how to make a directory writable for a webserver. In some cases no permissions alteration is required.

/license.bin

/public/robots.txt

/public/sitemap.xml

files have to be writable, set the access permission to -rw-rw-r-- (CHMOD 664).

 

MySQL Database.

phpListings software uses MySQL relational database management system to store its data. You can use an existing database or create a new one. Make sure the database has an associated user account that has all privileges for accessing and modifying all tables in that database.

If you are going to use an existing database that is already in use by a different software, please note that we use "phpls_" prefix for all tables not to overwrite your existing data.

 

Importing Database Dump.

When the database setup is ready you have to import the initial database dump to create all the required database tables and populate them with initial data.

You can find the /dump.sql file in the software package root folder.

We recommend to use phpMyAdmin tool to import the dump. Please consult the phpMyAdmin user manual on how to import SQL dumps into a database.

 

Configuration Files.

Use Filezilla or your favorite FTP client to access your installation and alter most important script configuration settings by editing the following text files:

1. /app/Config/App.php, you have to insert your license key and website URL similar to the example below (do not add trailing slash into the URL and make sure to include the sub-directory name if you have installed the script into a sub-directory of the web root):

<?php

return [
    // PUT YOUR PHPLISTINGS LICENSE KEY HERE
    'license' => 'PHPLS-4d519ffa5d4b',
    
    'debug' => true,
    'charset' => 'utf-8',

    // PUT YOUR WEBSITE URL HERE, NO TRAILING SLASH
    'url' => 'https://demo.phplistings.com',

    'theme' => 'default',

    'locale_fallback' => 'en',
    'locale_url_default_exclude' => true,
    'locale_browser' => false,
    'locale_storage' => 'files',
    'locale_path' => ROOT_PATH_PROTECTED . DS . 'I18n',

    'storage_path' => ROOT_PATH_PROTECTED . DS . 'Storage',
    'storage_size_limit_per_ip' => 1024*1024*200, // 250Mb
    'storage_file_limit_per_ip' => 1000,
];

 

2. /app/Config/Db.php, set your database host, database name, username and password similar to the example below. Please do not update driver name, charset and collation.

 

<?php

return [
    'default' => [
        'driver' => 'mysql',
        'host' => '127.0.0.1',
        'port' => '3306',
        'charset' => 'utf8mb4',
        'collation' => 'utf8mb4_general_ci',
        'db' => 'database',
        'username' => 'username',
        'password' => 'password',
        'prefix' => 'phpls_',
    ],
];

 

 

Final Steps.

Visit your website administrator panel at https://your-domain-name.tld/admin

Use the following credentials to access the panel for the first time:

Email: admin@phplistings.com

Password: admin

Open the "Users" menu and click the "Users" sub-menu. The only administrator account will appear in the list. Click the "Edit" button next to the user record. On the user form make sure to refresh the authentication token by clicking the "refresh" icon in the "Authentication Token" field, set new administrator email and password. Click the "Update" button to save your changes. Now your administrator account is secure.

The next step is to setup your SMTP mail server access credentials. Go to the "Settings" menu and click the "Settings" sub-menu. On the settings page select the "Mail" tab. This will open an email configuration form. Set the default email address and owner name to use as a sender for every script-generated email. Set the SMTP host, port, username, password and encryption method and click the "Update" button to save settings.

Now click the "Security" tab on the "Settings" page. Two options for encryption and authentication keys will appear. Click the "refresh" icon for each field and make sure new hash value has been generated. Click "Update".

Congratulations! All done! If you have any questions regarding the installation process, please, submit a support ticket.