VESTEL B2B Support Portal | CMS INSTALLATION GUIDE

CMS INSTALLATION GUIDE

INTRODUCTION

The VSign Content Management System (CMS) is a PHP web application which sits on a MySQL database. This feature enables this web platform to run on Linux or Windows servers that supports PHP/MySQL.

The requirements of VSign CMS installation are listed below.

  • MySQL 5.6
  • A web server (nginx, apache, iis)
  • PHP 5.6+ (lower than PHP7)
  • PHP-CLI 5.6+ (lower than PHP7)
  • Virtual Hosts or dedicated web server (modify DocumentRoot)

There are two steps to follow for installation of Vsign Content Management System.

  • Installation of web server
  • Installation of VSign CMS

Further sections will explain how to install CMS and upgrade the version of CMS. You can use following programs in those sections.

  • XAMPP: During the installation of web server on a Windows server, XAMPP will be used. You can download XAMPP installation file from Apache Friends. We suggest you to download the version that supports PHP 5.6. You can use “Shell” button that is on XAMPP control panel to open Shell in order to run shell commands.
  • PuTTY: You can use PuTTY when you need to run shell commands in order to perform installation and version upgrade on Linux server from Windows system via remote connection. You can download PuTTY installation file from PuTTY.
  • WinSCP: WinSCP is used for performing secure file transfer from Windows to remote Linux server. You can download WinSCP installation file from WinSCP. PuTTY is automatically installed with the installation of WinSCP. To open PuTTY go to “Commands” menu then click “ Open in PuTTY” in WinSCP.

Installing Web Server Environment

In this section, installation of web server environment which is the first step of VSign CMS installation will be explained. Once the environment is installed, there is no need to set up environment again for further CMS installations or upgrades.If you already have web server running with PHP/MySQL, you can skip this section and go to the next section (Install VSign CMS).

The most common and recommended installation is “LAMP” (Linux, Apache, MySQL and PHP).It is also possible to install on Windows by using XAMPP or by using IIS.

In following subsections, installing environment on Linux and on Windows is explained.

ON WINDOWS

In this section, web server installation on Windows system by using XAMPP will be explained. You can follow the steps that are stated below.

Download the XAMPP installation file from Apache Friends. Installing PHP 5.6 supported version is suggested.

Run XAMPPinstaller.

  • Select the components that you want to install. Make sure Apache, MySQL, and phpMyAdmin components are selected then click “Next” button on the screen that appears.
  • Figure 1 :Install XAMPP – Select Components Form

    • After you pressed “Next”, below screen appears for installation folder selection. By default, XAMPP installs to “c:\xampp”. Unless you need to move it somewhere else, then that’s a good choice. If you do select a different directory, remember it for the next step when we install VSign.

    Figure 2: Install XAMPP – Select Installation Folder

    • The installer will now run, and extract a number of files to the folder you select to install XAMPP.When the extraction of files is done, press “Finish” button to complete installation.
    • After the installation run XAMPP Control Panel. It should open up, and if everything went to plan, look like the screen shot.

     

    Figure 3: XAMPP Control Panel

    • At this point, you need to press Start buttons for both Apache and MySQL. As you click each, your screen should now look like the below:

    Figure 4: XAMPP Control Panel – Start Apache and MySQL

    • If you want to start Apache and MySQL automatically when starting XAMPP Control Panel, click “Config” button on top right of the XAMPP Control Panel. Then check Apache and MySQL boxes in “auto start of sections module” section and then press Save.

    Before we install VSign CMS, we need to configure a few things on XAMPP to make it a bit more secure.

    • From XAMPP Control Panel, click “Config” button, on the first line next to Admin button as seen in following screenshot and click “phpMyAdmin” to open “inc.php” file.

    Figure 5: XAMPP Control Panel – Configure PHP

    • In “config.inc.php” file, change the first line below with the second line.

    $cfg[‘Servers’][$i][‘auth_type’] = ‘config’

    $cfg[‘Servers’][$i][‘auth_type’] = ‘http’

     

    • After changing the line and saving the file, Restart Apache and MySQL.

    You will also need to configure “php.ini” file, which can be viewed by the context menu shown in the figure above, during installing CMS.

    • In the XAMPP Control Panel, click the “Admin” button next to MySQL. This will load a web browser and take you to an application called PHPMyAdmin that was installed along with XAMPP. It will let us setup a password for the “root” MySQL account. The “root” account on MySQL has privileges to add new users, create databases etc. so needs to have a strong password.
    • From the PHPMyAdmin screen, click “User Accounts” at the top of the screen. You’ll see the database users that exist already listed. We’re interested in the one called “root” that has “localhost” in the “Host” column. Click the blue “Edit Privileges” symbol to the right of the word “Yes”.

    Figure 6: PHPMyAdmin – Configure User Accounts

    • On top of page, you find the “Change Password” box. Enter a new password in both the password boxes and click “Go”. On a piece of paper, write down “MySQL Admin User details. We’ll need these later when installing CMS.

    Figure 7: PHPMyAdmin – Change Password

    Now we are ready to extract VSign CMS package.

    Install on linux

    In this section, web server installation on Linux will be explained. Ubuntu 14.04LTS is recommended. There are some notes further down for other distributions; however the whole procedure is very similar.

    We need to setup Apache and PHP. This procedure will be explained for Ubuntu 14.04 LTS and for other distributions in the following subsections.

    Ubuntu

    In this subsection, installation of Apache, MySQL and PHP5 will be explained. Follow the steps that stated below respectively and enter related commands. 

    INSTALLING APACHE, PHP and MYSQL ON UBUNTU 20.04

    Step 1 – Add Apache

    sudo apt-get install apache2

    Step 2 – Add PHP PPA

    First of all, you need to configure repository on your system. Run the following command to add

    ondrej PHP repository to your Ubuntu system.

    sudo apt install software-properties-common

    sudo add-apt-repository ppa:ondrej/php

    The above command will also update the packages information list. But if you already have

    repository added, then update the packages information before installing or updating package:

    sudo apt update

    Once the update complete, lets begin the PHP installation.

    Step 3 – Install PHP 5.6

    PHP 5.6 is an outdated version. Its development is stopped and no more security updates

    available. But if you application still relies on this version use below command to install it.

    sudo apt install -y php5.6

    Step 4 – Check PHP Version

    To view the current active PHP version run the following command:

    php -v

    PHP 5.6.X (cli) (built: Jul 13 2020 16:46:22) ( NTS )

    Copyright (c) The PHP Group

    Zend Engine v3.4.0, Copyright (c) Zend Technologies

     with Zend OPcache v7.4.8, Copyright (c), by Zend Technologies

    Step 5 – Install MySQL

    sudo apt-get install php5.6-mysql

    CentOS 5.x / Redhat RHEL 5.x

    In this subsection, installation of web server on CentOS 5.x/Redhat RHEL 5x will be explained. Apache, MySQL and PHP5 installations are the same. You can follow the steps that mentioned in previous subsection.

    Since JSON extension is not include in CentOS 5.x or Redhat RHEL 5.x, you should install it. You can follow these steps to install :

  • Install JSON PHP Extension
  • yum install php-devel

    If you have more than 8MB of memory limit for PHP, install with PEAR :

    pear install pecl/json

    If you have less than 8MB of memory limit for PHP, PEAR failed to install… Use PECL :

    pecl install json

  • Active JSON extension :
  • vim /etc/php.d/json.ini# JsonExtensionextension=json.so

  • Save file and restart the Apache webserver :
  • /etc/init.d/httpd restart

    Installing VSign CMS

    In this section installation of VSign CMS will be explained. It is assumed that a web server running with PHP and MySQL is available. If not, please look into previous section.

    Installation of VSign on web server is performed according to following steps.

  • Placing CMS package
  • Starting VSign CMSInstallation
  • Pre-Requisities
  • Creating The Database
  • Creating Administrator Account
  • Final Configuration
  • Complete
  • PLACING CMS PACKAGE

    In this subsection, transferring CMS installation files to web server and web server configurations will be explained.

  • Now it is required to transfer CMS installation package to server. When the CMS installation archive is extracted, the extracted archive should look like below:
  • Figure 8: Install CMS – Extracted CMS Archive

    • In the simplest of web server configurations the name of this folder will be the name of the URL you use to access the CMS. For example if you name folder as VSign, the URL of the CMS will be http:\\localhost\Vsign

    That process will be explained in detail for Windows and Linux in following subsections.

    After extracting the CMS archive into appropriate location, we are ready to start the CMS installation

    Placing CMS Package on Windows

    Transfer VSign installation directory (e.g. vsigncms-v1.0.0.zip) to web server then extract to web server’s DocumentRoot location. For example, if DocumentRoot“C:/xampp/htdocs” and folder that you extract to is “vsign” then associated location will be “C:/xampp/htdocs/vsign”. In addition:

  • Install ffmpeg. For intallation, in FFMPEG Download page refer to ‘Get The Packages’ section and download related package for Windows. After download and locate ffmpeg package on your PC, add path of ffmpeg binary files to Windows Environment variables.
  • Install language packages required for weather widget if display language is required to change.
  • Placing CMS Package on Ubuntu

    Follow the instructions stated below respectively.

    • Copy VSign CMS directory (e.g. vsigncms-v1.0.0.zip) to your user’s home folder (/home//) in your web server.
    • Extract the tarball you downloaded inside your webserver’s document root (eg /var/www/vsign) and ensure the webserver has permissions to read and write those files:

    cd /var/wwwsudo tar zxvf ~/vsignCMS-v1.0.6.tar.gzsudo mv VsignCMS-v1.0.6vsign

    • Change transferred folder’s owner as www-data.

    sudo chown www-data:www-data -R vsign

    • Make a directory for the server library. Make sure the webserver has permission to write to this location:

    sudo mkdir /vsign-librarysudo chown www-data:www-data -R /vsign-library

    • Install ffmpeg. For intallation, in FFMPEG Download page refer to ‘Get The Packages’ section and download related packages. For Ubuntu packages, execute following commands respectively:
      • For Ubuntu 14.04 (Trusty)

      sudo add-apt-repository ppa:mc3man/trusty-media

      sudo apt-get update

      sudo apt-get dist-upgrade

      sudo apt-get install ffmpeg

      • For Ubuntu Vivid, Wily, Xenial

      sudo apt-get install ffmpeg

      • Install language packages required for weather widget if display language is required to change. For Ubuntu, execute following commands respectively:

      locale -a

      If desired language package is not in the list viewed by executing above command, execute following command. Assuming Turkish language package is desired:

      sudo apt-get install language-pack-tr

    Starting VSign CMS Installation

    Navigating to http:\\your.server\path (e.g. http:\\localhost\VSign) will automatically start the installation.

    The installation is in a wizard format that contains 5 steps in total. The wizard will guide the installer through the process of installing VSign.

    Pre-Requisites

    Please follow the steps below:

    • After navigating to http:\\your.server\path, the below page appears.

    Figure 9: Install CMS – Pre-requisites

    This page contains a detailed check list of all the items required for a successful installation. Each item will have either:

    • A tick – the item is present and correct
    • An exclamation mark – the item is present but may not be configured correctly.
    • A cross – the item is missing.
    • Any items with an exclamation mark or a cross should be corrected. When any item with an exclamation mark or a cross is solved, the Retest button must be used to run this step again. Exclamation mark or cross stem from PHP modules that did not configured correctly. This problem can be solved by either activating missing modules in your “php.ini” file related to your server’s PHP settings or setting some values according to minimum configuration settings. Necessary solutions can be found on the installation page. To sum up, check the necessary extensions are whether active or not as stated below.

    extension=php_curl.dll

    extension=php_fileinfo.dll

    extension=php_gd2.dll

    extension=php_gettext.dll

    extension=php_mysql.dll

    extension=php_mysqli.dll

    extension=php_pdo_mysql.dll

    extension=php_soap.dll

    extension=php_intl.dll

    extension=php_openssl.dll

    Also set following parameters to minimum value as stated.

    max_execution_time=120  (min. 120 sn.)

    post_max_size=16G(min. 128M)

    upload_max_filesize=16G(min. 128M)

    In order to use Ticker, Weather and Twitter modules and CDN feature, please make sure SSL and Curl certification settings are done accourding to following settings.

    curl.cainfo=[path to cacert.pem]

    openssl.cafile=[path to cacert.pem]

    These extensions are usually inactive in Windows server. You can download related files from this link curl website.

    For Linux servers downloading ca-sertificates package will be enough. 

    • After changing the line and saving the file (ini), don’t forget to restart Apache.

    For Linux run following command

    sudo service apache2 restart

    For Windows, press “Start/Stop” buttons located on xampp control panel.

    • Once all the items are ticked press Next button to advance.

    Creating the Database

    After pre-requisites step is passed, the below page appears.

    The CMS can install into a new database, or an existing one. We recommend a new database. Because, VSign does not prefix its table names and may conflict with content in an existing database. The choice for a new or existing database can be made by switching between the two available tabs.

    Whether you chose an existing database or a new one, the installer will need to collect some information about that database to allow the CMS to connect, read and write.

    Figure 10: Install CMS – Creating DataBase

    The installer will need the following information:

    • Host: The host name for your MySQL installation – in the majority of cases this will be “localhost”.
    • Admin Username: The “root” user name for your MySQL installation. This is only used for the installation and is only required if you have asked the installer to create a new database.
    • Admin Password: The “root” password. This is only used for the installation and is only required if you have asked the installer to create a new database.
    • Database Name: The name for the CMS database. Give a name you choose.
    • Database User name: The user name for the CMS to use to connect to the database – usually this can be the same. Give a name you choose.
    • Database Password:The password to use to connect to the database. Give a password you choose.

    After you fill the form, press Next button. The installer will now create / populate database for VSign. You should see a series of dots appear on the screen as this happens. It can take a few moments to complete. 

    Creating Administrator Account

    After creating database step is passed, the following page appears:

    Figure 11: Install CMS – Creating Administrator Account

    Each installation will require at least one “Super User” level Administrator to manage the system, apply upgrades and configure the advanced settings. Just give any user name and password you choose.

    This user name and password should be kept safe as it will be required when the installation is complete.

    Final Configuration

    After creating administrator account step is passed, the following page appears:

    Figure 12: Install CMS – Final Configuration

    Fill in the blanks on the appeared screen, in order to set last settings of VSign CMS.

    • Library Location (Kütüphane Konumu): Location that CMS stores its documents and media files. This directory is generated when placing previous installation files.For example, “/vsign-library/” for Linux, “C:\vsign-library” for
    • Server Key (Sunucu Anahtarı): This key will be used to authorize screens that trying to connect to CMS. A key is generated automatically while installation. After installation is completed, the CMS Key can be viewed or can be changed via Administration à Settings page of CMS web interface.
    • License Key (Lisans Anahtarı): Necassary key to licence CMS software. If needed please consult to your sales assistant.

    Complete

    The installation is now complete and the system is ready to log in.

    Figure 13: Install CMS – Complete

    Now you can use user name and password of administrator account you created during installation process.

    Upgrading Vsign CMS Version

    In this section, the steps for upgrading Vsign CMS version will be explained. In following subsections, you can follow the detailed process of the version upgrade on Windows and Linux system.

    On Windows

    • You can follow the next steps with the following assumptions.

    MySQL administratorID:mysqladmin

    Vsign database name: vsigndb

    • (Optional) Clone your existing Vsign database and give necessary permissions. It is possible to upgrade the version without cloning however it will be harder to undo the process in case of an error occurrence. To see how to clone your database, check out the next section “CLONING DATABASE”.
    • Backup the file “settings.php” which located in your existing Vsign installation directory.
    • Backup the file “fonts.css” which located under “modules/preview” folder in your existing Vsign installation directory.
    • Backup your existing Vsign database.

    mysqldump –u mysqladmin –p vsigndb>vsigndb.sql

    • Transfer new version’s installation archive to the server.
    • Copy Vsign’s new version’s installation files to your existing Vsign installation directory.
    • Copy “settings.php” file that you backed up to your existing Vsign installation directory.
    • Copy “fonts.css” file that you backed up to “modules/preview” folder under your existing Vsign installation directory.
    • Enter http:\\your.server\path (For example, http:\\localhost\VSign) in the web browser address bar.
    • Login as administrator.
    • Navigate through automatic given version upgrade steps.

    On Linux

    • You can follow the next steps with the following assumptions.

    MySQL administrator ID: mysqladmin

    Vsigndatabase name: vsigndb

    Serves’sdirectory: /var/www/html

    ExistingVsigninstallation directory: /vsign

    NewVsigninstallation archive: vsigncms-yeniversiyon.zip

    • (Optional) Clone your existing Vsign database and give necessary permissions. It is possible to upgrade the version without cloning however it will be harder to undo the process in case of an error occurrence. To see how to clone your database, check out the next section “CLONING DATABASE”.
    • Backup the file “settings.php” which located in your existing Vsign installation directory. For example, you can copy it to your user’s home folder.

    sudo cp settings.php ~

    • Backup the file “fonts.css” which located under “modules/preview” folder in your existing Vsign installation directory. For example, you can copy it to your user’s home folder.

    sudo cp modules/preview/fonts.css ~

    • Backup your existing Vsign database.

    mysqldump –u mysqladmin –p vsigndb> ~/vsigndb.sql

    • Transfer new version’s installation archive to the server.
    • Copy Vsign’s new version’s installation files to your existing Vsign installation directory. You can perform following steps in order to do that.

    Export Vsign’snew version archive to your server’slocation.

    cd /var/www/html

    sudo unzip ~/vsigncms-yeniversiyon.zip

    Change folder’s owner into www-data then copy it to your existing Vsign installation directory.

    sudochownwww-data:www-data -R vsigncms-yeniversiyon

    sudo cp –avrvsigncms-yeniversiyon/. vsign

    • Copy “settings.php” file that you backed up to your existing Vsign installation directory.

    sudo cp –rf ~/settings.php vsign

    • Copy “fonts.css” file that you backed up to “modules/preview” folder under your existing Vsign installation directory.

      sudo cp –rf ~/fonts.css vsign/modules/preview

    • Enter http:\\your.server\path (For example, http:\\localhost\VSign) in the web browser address bar.
    • Login as administrator.
    • Navigate through automatic given version upgrade steps.

    Cloning VSign Database

    In this section, you will find explanation to how to backup and reconfigure your Vsigndatabase. Relevant commandsare processed through Shell that is on the server.

    • You can follow the next steps with the following assumptions.

    MySQL administrator ID:mysqladmin

    MySQL VSignuser: vsigndbuser

    Existing MySQL database: vsigndb

    New MySQL database: vsigndb2

    • Following command is run in order tobackup the database to a file.

    mysqldump –u mysqladmin –p vsigndb>vsigndb.sql

    • Run following command then enter mysql admin password.

    mysql –u mysqladmin –p mysql

    • Following commands are run in order to generate new database.

    create database vsigndb2;

    grant all priviliges on vsigndb2.* to `vsigndbuser`@`localhost`;

    use vsigndb2;

    source vsigndb.sql

    quit

  • Generated database’s name can be changed if desired. You need to change settings in the “settings.php” file which located in Vsign installation directory
  • Post-Installation Settigns/h3>

    Once your VSign CMS is installed, there’s some additional setup required to enable all functionality and to keep things running smoothly.

    CDN

    Uploading media files to Amazon Web Services – CDN and make VSign Clients download files over CDN is possible with VSign. In order to use CDN, complete the following steps:

    • Go to the Settings page of CMS and then go to CDN tab.
    • Enter the AWS Secret Access Key ID, AWS Secret Access Key, AWS Library Name, AWS Region and CDN URL. These setting will be given by your CMS administrator.
    • Go to the General tab.
    • Set “File download mode” to “CDN”.
    • Save settings and wait until “Settings Updated” message is displayed.

    Maintenance and Email Alerts

    Maintenance is an important part of any system and should always be configured. Maintenance is configured in the CMS settings, under the Maintenance tab. And also, in order to carry out certain background routines (eg clearing out old records) or to alert you if one of your Players stops connecting as expected, you need a regular “wakeup” to run VSign to allow those things to happen. Therefore, maintenance script (maintenance.php) is required to be executed.

    Maintenance Script

    The “maintenance.php” script should be run on your CMS from the Windows Task Scheduler, or from cron every few minutes.

    Maintenance On Windows Servers

    On Windows servers, Windows Scheduled Task can be used to run maintenance. Inorder to setup a sample windows schedule task, complete following steps:

    • Find the php.exe or php-win.exe program on your server. It will be in your PHP installation directory.
    • Go to Start -> Control Panel -> Scheduled Tasks ->CreateBasic Task.
    • Type “VSign Maintenance” as the name of the task and select “Daily” as the schedule. Click “Next”.
    • Select “12:00 AM” as the start time, perform the task “Every Day” and choose today’s date as the starting date. Click “Next”.
    • Click the “Browse” button and browse to your php.exe or php-win.exe and click “Open”.Type the following in the “Add Arguments:” text box:

    –f C:\path\to\vsign\maintenance.php key

    Replace key with your Maintenance Key if you are running in Protected Mode.

    • Enter the username and password of the user the task will run under (it does not have to be a privileged account at all).Make sure you type the password correctly. Click “Next”.
    • Mark the checkbox titled “Open advanced properties for this task when I click Finish” and click “Finish”.
    • Click on the “Triggers” tab and there in the “Edit” button.
    • Mark the “Repeat task” checkbox and set “Every:” to 5 minutes, and set “for a duration of” as 1 day.If you are Alert Timeouts are less than 5 minutes, you may want to run the maintenance script more often.
    • Click “OK”.* Test your scheduled task.

    Maintenance On Unix Servers

    There are different command line programs you can use to call the maintenance page from the command line. Not all of them may be available on a given server. Following are some sample methods you can use:

    • Using a Unix utility like ‘wget’:

    wget –q –O /dev/null http://example.com/VSign/maintenance.php?key=changeme

    • Using lynx:

    lynx –dump http://example.com/VSign/maintenance.phpchangeme> /dev/null

    • Using a standalone version of PHP, compiled to be run on the command line:

    The disadvantage is that you need to have access to a command-line version of php. The advantage is that your web server logs are not filled with constant requests to maintenance.php and you can run at a lower I/O and CPU priority.

    php /var/www/html/VSign/maintenance.phpchangeme

    Example command to run at a lower priority

    Ionice –c3 –p$;nice –n 10 /usr/bin/php /var/www/html/VSign/maintenance.phpchangeme> /dev/null

    Running Maintenance With Crontab

    Most unix-based servers run a version of cron. Cronexecutes commands on a schedule. Modern Linux distributions use a version of cron that reads its configuration from /etc/crontab.

    Inorder to run maintenance with crontab, complete following steps:

    • If you have an /etc/crontab, edit it with your favourite editor, otherwise run the following to edit the crontab:

    crontab –e

    • Add one of the above commands like:

    */5 * * * * wget –q –O /dev/null http://example.com/VSign/maintenance.php?key=changeme

    The first five entries are the times to run values, followed by the command to run. The asterisk is a wildcard, indicating any time.The five time-and-date fields cannot contain spaces. The five time-and-date fields are as follows: minute (0-59), hour (0-23, 0 = midnight), day (1-31), month (1-12), weekday (0-6, 0 = Sunday).The above example means run the command wget -q -O /dev/null… every 5 minutes (/5), every hour (*), every day of the month (*), every month (*), every day of the week (*).

    For further information aboutcron usage, you can visit following links:

    Email Alerts

    Once maintenance script is woken up, you can optionally configure email alerts to be sent when Players stop connecting properly, and when they come back online after a period of downtime.In order to send email notifications, complete following steps:

    • Go to the CMS Settings page and then Maintenance tab.
    • Set “Enable Maintenance”(MAINTENANCE_ENABLED).
      • Off: All maintenance functionality is disabled.
      • On: All maintenance functionality is enabled. You can use any of the methods below to call the maintenance script on a schedule without specifying a key.
      • Protected: All maintenance functionality is enabled. You must specify the correct key when calling the maintenance script. This is to prevent unauthorised persons from repeatedly calling the script and generating large amounts of alert email.
    • Set Enable Email Alerts (MAINTENANCE_EMAIL_ALERTS) to “On”.

    Globally enable or disable the sending of email alerts. You can enable/disable alerts for individual displays in Display Management.

    • Enter “Maintenance Key” (MAINTENANCE_KEY).

    The secret key required to allow the maintenance script to run when “Maintenance Enabled” is set to “Protected” mode.

    • Enter “Send repeat Display Timeouts” (MAINTENANCE_ALWAYS_ALERT).

    If set to “On” will mean for each offline display, you’ll receive an email every time the maintenance.php routine is run. If set to “Off” will mean that you’ll be notified only once per downtime period.

    • Enter “Max Display Timeout” (MAINTENANCE_ALERT_TOUT).

    The time in minutes after you last see a Player connect to the CMS that you consider it to have gone offline. It can be overridden on a per-display settings profile basis should you need that. Do not set this value lower than your normal Player collection interval. The default is 30 minutes.

    • Enter SMTP Server Address (SMTP_HOSTNAME), SMTP Username (SMTP_USERNAME) and SMTP Password (SMTP_PASSWORD), SMTP Port and SMTP Encryption type.
    • Enter “Admin email address” (mail_to).
    • Enter “Sending email address” (mail_from).
    • Save settings.

    In some cases it’s also useful to alert users if a Player goes offline. If you want to alert all users who have view permissions to a display,

    • Go to the Displays tab.
    • Tick “Maintenance Alerts for Users”(MAINTENANCE_ALERTS_FOR_VIEW_USERS).
    • Save settings.

    In order to decide which Displays you want to receive alerts for, complete following steps

    • Go to Displays page in the CMS.
    • Click Edit for display and move to Maintenance tab.
    • Set Email Alerts to “Yes”.
    • Enable/Disable “Use Global Timeout”.

    If you aren’t using Display Settings Profiles, be sure to tick the Use Global Timeout tick box. So that the value you set earlier for the time a display needs to be offline before you’re alerted is used. If you’re using Display Settings Profiles, then if that box is unticked, the display collection interval from the Display Profile is used instead.

    • Save settings.

    Log and Statistics Retention

    The CMS generates log output when it’s running, and also receives log output from the Players connected to it for the purposes of debugging and checking the system’s state. It can also collect proof of play records called Statistics. All these records are held in the database and should be purged periodically to keep the size of the database manageable and to prevent system performance problems. The maintenance script performs that function.

    In order to configure log and statistics retention related settings, complete following steps:

    • Go to the CMS Settingspage,and then Maintenance tab.
    • Set “Enable Maintenance”(MAINTENANCE_ENABLED).
      • Off: All maintenance functionality is disabled.
      • On: All maintenance functionality is enabled. You can use any of the methods below to call the maintenance script on a schedule without specifying a key.
      • Protected: All maintenance functionality is enabled. You must specify the correct key when calling the maintenance script. This is to prevent unauthorised persons from repeatedly calling the script and generating large amounts of alert email.
    • Set “Max Log Age” (MAINTENANCE_LOG_MAXAGE).

    How many days worth of log messages to keep. Logs older than this will be deleted. Set to 0 to keep all logs indefinitely.

    • Set “Max Statistics Age” (MAINTENANCE_STAT_MAXAGE).

    How many days worth of statistics to keep. Statistics older than this will be deleted. Set to 0 to keep all statistics indefinitely.

    Timezone

    In order to set CMS timezone, complete following steps:

    • Go to the Settings page, and then the Regional tab.
    • Select the nearest major city in your timezone.
    • Click Save at the bottom of the page.

    CMS Timezone must not be confused with User Timezone. User Timezone (configured via Administration -> Users page) is used in all dates displayed on CMS pages. However in the background  UserTimezone is converted to CMS Timezone and is saved as CMS Timezone. Dates must be global for all Displays connected to CMS (egSchedules are sent to Displays in CMS time zone).

    Large File Uploads

    Your users will almost certainly want to start uploading images and video to the VSign CMS. In order for that to happen, PHP and your webserver must be configured correctly to support large file uploads.

    Language Detection

    By default, the CMS will use the language preferences set in your web browser to auto-detect which language to display the CMS interface in. In some instances, for example where only small parts of the CMS have been translated in to a particular language, it may be desirable to disable language detection and enforce a specific language instead.

    • Go to Settings page of the CMS, and then move to the Regional tab.
    • Untick the Detect Language (DETECT_LANGUAGE) tick box.
    • Select a suitable default language.
    • Save your changes.

    Default Language

    If you disable language detection, the CMS will need to know which language file to take it’s translations from.

    • Go to Settings page of the CMS, and then move to the Regional tab.
    • Select Default Language (DEFAULT_LANGUAGE) value from the list.
    • Save your changes.

    Display Settings Profiles

    Display Settings Profiles offer a powerful way of centrally configuring your Player settings from the CMS. When the Players connect to the CMS, they will receive any default or assigned profile you’ve created and reconfigure themselves with those settings automatically.

    You’ll find the profiles in the Display Settings page of the CMS. You can create default profiles for each Player type, or individual profiles which can then be applied to one or more Players to override the default settings.

    THIRD PARTY INTEGRATIONS

    CURL SSL SETUP

    The CMS will need to be able to validate SSL certificates are valid when it talks to third party servers (for integrations such as Twitter, Forecast IO or for RSS feeds consumed over HTTPS links) so be sure that your PHP installation is setup to allow that. See Installation Prerequisites section for further information.

    Weather Forecast API Key

    The module comes pre-installed on CMS installations, but needs an API key from DarkSky API to function correctly. This should be obtained by creating an account and (if you will exceed 1000 calls per day) entering your billing information.

    This configuration is entered in the Module Administration page by editing the “Forecast IO” module.

    There are two settings required:

    • API Key

    The API key is obtained after registering an application on the Forecast developer website.The API Key identifies the CMS with Forecast and allows the CMS access to the weather data.

    • Cache Period

    Forecast allow 1000 requests for a forecast per day before charging a small fee for each subsequent request.The CMS allows a cache period to be specified which will create a delay between requests for each geographic location.

    Twitter API Key

    Access to the Twitter API is protected and users must register for an API key and enter that key in to the VSign CMS settings. This configuration is entered in the Module Administration page by editing the “Twitter” module.