CCMS Installation Instructions

Transcription

1 CCMS Installation Instructions August 2012 Rev Ceedo Technologies, Ltd. 21 Hamelacha St. P.O. Box Park Afek, Rosh-Haayin, Israel T Ceedo Technologies, Ltd. All rights reserved. Ceedo is a registered trademark of Ceedo Technologies, Ltd. All other trademarks and service marks are the property of their respective owners. 1

2 Contents Overview Preparations Hardware Requirements Infrastructure Requirements For Heavy Loads and Optimizations What is the optimal hardware configuration for a CCMS server? Software Requirements Installing CCMS Downloading the CCMS Installation files First Installation: Installation on a Linux Server Installation on a Windows Server Editing the Configuration File Post-Installation Verifications Logging into the Administrator's Account Upgrade Installation: Upgrading the files: SQL Upgrade Instructions Hosting the Platform files Hosting your own Company-branded Ceedo Updates To use this package Future updates of platform resources Connecting to Active Directory Configuring a CCMS Account to Connect to Active Directory Data Synchronization Troubleshooting System Prerequisites Page Empty Versions Combo-boxes in Settings CCMS Doesn t Work With Your Proxy 2

3 3

4 Overview This document lists the CCMS installation instructions and requirements for having CCMS running on your own server inside your own datacenter. Ceedo also offers CCMS as a SaaS application where all this is not required,and you can be up and running in 5 minutes. CCMS is provided to selected customers and partners on a per-request basis. Please contact your Ceedo sales rep if you do not have the link available to you. CCMS release notes are maintained here If this is the first installation of CCMS, please follow these instructions. If this is an upgrade, please forward to the CCMS upgrade instructions. Preparations Before attempting to install CCMS Server it is highly recommended to complete the CCMS Questionnaire and forward it to Ceedo. A properly filled Questionnarie will be required in order to request assistance from Ceedo regarding the CCMS installation. Hardware Requirements 1. CPU Any Intel/AMD CPU with a clock speed of > 2GHz or higher 2. If the amount of users increases to more than 100, then an i5 or i7 (or equivalent) CPU is recommended 3. RAM Minimum of 1GB RAM The amount of RAM will need to be increased based upon the number of users 4GB of RAM is sufficient to serve 500 users 4. Storage 250GB RAID1 array is recommended Infrastructure Requirements 1. The server must be able to communicate Ceedo s Activation server by means of HTTP access: ActivateCeedoClient3 and CeedoPLPBackend.asmx/GetActivationCodeDetails 2. The server must be accessible using a domain name instead of an explicit IP address. For example: NOT For Heavy Loads and Optimizations 1. Use a separate database server if you have more than 5,000 users 2. Storage for this amount of users should be 1TB Workspace file packages should be stored on a separate server, and need to be accessible from the CCMS server via HTTP What is the optimal hardware configuration for a CCMS server? A CCMS server primarily responds to client events. The recommended hardware requirements are determined by the number of requests the server handles. The more concurrent client events the CCMS 4

5 server receives, the more high-end the server should be. The more information stored in the reports table, the higher the capacity of the server s hard drive should be. The number client events is the multiple of the number of users by number of expected requests per user. The number of requests per user is a key parameter, and is very much subject to the administrator-required configuration. On one hand, an administrator may require that end-users request validation only when starting Ceedo, but not submit any activity reports to the server. On the other hand, the administrator may prefer to configure Ceedo Enterprise in such a way that it will contact the server every 15 minutes while Ceedo is running to check for updates, messages, etc. A server for 10,000 users which just needs to occasionally update a package or two, as in the first scenario, will be far less active than a server which has been set up for 500 users who work as described in the second scenario, and will require dramatically less storage. The storage requirements of a CCMS server are almost entirely affected by the per user statistics reports generated. The above is why there is no definitive answer to the question of what the optimal hardware configuration (speed/capacity) for a CCMS server should be. The hardware configuration of a CCMS server can always be upgraded after initial roll out if the need for additional resources arises. Software Requirements Apache version 2.0 or greater Apache should support the.htaccess file for URL rewriting (e.g. mod_rewrite) This can be configured using the tutorial located here The.htaccess file is already included in the CCMS package PHP version or greater PHP modules such as: php-common, PHP-Pear, PHP-PDO, PHP-PECL-memcache, PHP-GD, PHP-mbstring, PHP-MCrypt, PHP-MYSQL and PHP-XML PHP-oci8 and oracle instant client are required for oracle database MySQL version 5.0 or greater OpenSLL must be installed on the server SELINUX must be disabled (especially true for Fedora, see CCMS Pages Appear Empty and Blank in troubleshooting section as to how to disable) That s really it, we have tested CCMS installation on Debian, Ubuntu CentOS and Fedora and we recommend that you use one of those distributions. That said, we cannot test every possible environment, so feel free to let us know if you run into problems with a specific configuration. 5

6 Installing CCMS Downloading the CCMS Installation files 1. Download the latest CCMS.tgz 2. Extract the.tgz file to an easily-accessible location on the PC First Installation: This section contains instructions on how to set up your server and CCMS for the first time. See the Upgrade Installation section below for upgrade instructions: Installation on a Linux Server 1. Copy the new version to the final location on the server Make sure you also copy hidden files. Ensure that the.htaccess file is in the root folder of your domain, and not in the subfolder to which the CCMS files were uploaded 2. Log into PHPMYADMIN as root and create a new user and a database for that user Assign appropriate permissions and sign out 3. Log into PHPMYADMIN with the new user and import the database script for your CCMS version: mysql_script_[version].sql (for example: mysql_script_ sql). The database scripts are located at dbscripts\mysql 4. /application/policyfiles, /application/views/templates_c and /system/logs or ccms must be writable by apache. 5. Configure the CCMS settings in serverconfig - example.php in application/config folder according to the instructions in the Editing the Configuration Files section of this document Rename this file to: serverconfig.php 6. Run the post-installation verification test page to verify CCMS was installed correctly 7. If you wish to host the Ceedo Enterprise client resources on your server instead of on Ceedo's Amazon cloud storage, follow the instructions below on how to host your company's co-branded resource files Installation on a Windows Server 1. Install XAMPP. The setup file is available here The guide to installing XAMPP is available here 2. Configure the Virtual Host in Apache The guide to configuring the host is available here 3. Enable openssl Edit php.ini file in xampp\php, adding the following line at the end of the [PHP] section: extension=php_openssl.dll Restart Apache 4. Extract the CCMS package into your virtual host folder 5. Set up the password for the root user for mysql The guide to changing the root password is available here 6

7 6. Login to PHPMYADMIN (already bundled in XAMPP) as root, and create a new user and database for that user. Assign appropriate permissions and sign out PHPMyAdmin can be accessed from the XAMPP admin panel by clicking the Admin button next to MySQL 7. Login to PHPMYADMIN with the new user and import the database script for your version: mysql_script_[version].sql (for example: mysql_script_ sql), the database scripts are located at dbscripts\mysql 8. Configure the CCMS settings in serverconfig-example.php located in the application\config folder according to the instructions in the Editing the Configuration Files section of this document Rename this file to: serverconfig.php 9. In your Web browser, go to the post-installation verification test page to verify CCMS was installed correctly - this step is required! Editing the Configuration File Note: It is recommended that you use a programmer's notepad for editing the configuration files. Edit the serverconfig.php file located under /application/config. If this file does not exist, you should rename the serverconfig-example.php to serverconfig.php first. This file contains six sections: General, SMTP, Database, Proxy, Error logs and Prerequisites Passwords.. General Under the General section: Replace the text ccms.yourserver.com with your CCMS server URL. The string containing "ccms.yourserver.com" looks like this: $config['specialredirection'] = "ccms.yourserver.com"; Under the SMTP section, add your server information. To do this: Add the following information in this order: 1. SMTP Host Address 2. SMTP Port Number 3. SMTP User Name 4. SMTP Password The strings to which this information will be added are as shown below (the information goes in between the single quotes inside the square brackets, like so: $config['smtp_host'] = "smtp.yoursite.com";): $config['smtp_host'] = ""; // Put the SMTP host address $config['smtp_port'] = 25; // Put the SMTP port number $config['smtp_user'] = ""; // Put the SMTP username here $config['smtp_pass'] = ""; // Put the SMTP password here Note: If you are using Exchange with TLS you must also set the ['starttls'] to be TRUE Database Under the database section, add your DB connection information. To do this, add the following information in this order: 7

8 1. Database Host Name 2. Database User Name 3. Database Password 4. Database Name The strings to which this information will be added are shown below (the information goes in between the single quotes inside the square brackets, like so: $db['default']['hostname'] = "localhost";): Database Host Name: $db['default']['hostname'] = ""; Database User Name: $db['default']['username'] = ""; Database Password: $db['default']['password'] = ""; Database Name: $db['default']['database'] = ""; Proxy Server If you do not use a proxy server to access the Internet you can skip this section. If your CCMS server requires a proxy server to access the activation and platform servers, you will need to configure the proxy settings here. These proxy settings are separate from the server s proxy settings, and must be used if you require a proxy. Note: CCMS only supports web-proxies. If you use a different type of proxy refer to Troubleshooting sections. Under the Proxy section, add your proxy connection. To do this, add the following information in this order: 1. Proxy URL and Port 2. Proxy username and password 3. Use for Activation Server (If your server required proxy to access activation server.) 4. Use for default directortyinfo.html (If your server required proxy to access default platform URLS.) 5. Use for custom directoryinfo.html (If your server required proxy to access platform URLS.) 6. Use for Workspace files (If your server required proxy to Workspace files.) 7. Use for Package files (If your server required proxy to Package files.) The strings to which this information will be added are shown below (the information goes in between the single quotes inside the square brackets, like so:$config['proxy_auth'] = 'exuser:expass';): The Use for... values receive TRUE or FALSE, like so: $config['useproxy_activation_server'] = TRUE; Proxy URL: $config['proxy'] = ''; Proxy Authentication: $config['proxy_auth'] = ''; Use for Activation Server: $config['useproxy_activation_server'] = ; Use for default directortyinfo.html: $config['useproxy_default_directoryinfo_urls'] = ; Use for custom directoryinfo.html: $config['useproxy_directoryinfo_urls'] = ; Use for platform file: $config['useproxy_workspace_files'] = ; System Prerequisites page The system prerequisites page displays information regarding your server and provides tests for your CCMS configuration. We recommend you change the default values for this page to increase security. Prerequisites User Name: $config['system_prerequisites_username'] = 'administrator'; Prerequisites Password: $config['system_prerequisites_password'] = 'password'; Post-Installation Verifications It is crucial that the CCMS installation be tested before trying to work with it. After the installation, use your Web browser to go to the System Prerequisites page for example: /cmdemos.ceedo.com/index.php/systemprerequisites. Replace the cmdemos.ceedo.com with your CCMS server URL. After entering the username and password you ve set in the server-config file the page 8

9 displays results of various tests. The default System Prerequisites login credentials are: Username: administrator Password: password If everything is marked OK, you are good to go. If, on the other hand, you do not see the prerequisites page with all items marked with OK in green as shown in the screenshot below, you should not begin working with CCMS - all issues must be resolved before going on to the next step! If one or more of the System Prerequisites tests failed, you can refer to the Troubleshooting section for frequently encountered issues and solutions. Logging into the Administrator's Account Once the installation has completed, use the following credentials to log into the CCMS administrative account: 1. User Name: administrator 2. Password: admin Upgrade Installation: Upgrading the files: Overwrite all your previous files with the new files from the archive. If you are using a Linux server, it is highly recommended that you extract the files directly to the Linux server to prevent loss of file ownerships and permissions. 9

10 Please note that if you are upgrading from a version lower then you will need to update your server-config.php file and add the prerequisites password (you can take it from the serverconfigsample.php file). SQL Upgrade Instructions For an upgrade, you need to import versions incrementally (e.g. if you are upgrading from to you need to import mysql_migration_script_ _to_ sql, mysql_migration_script_ _to_ sql and mysql_migration_script_ _to_ sql in that order). The scripts are located in /dbscripts/ Hosting the Platform files Hosting your own Company-branded Ceedo Updates It is possible to host your own company-branded Ceedo updates for CCMS. Ceedo can prepare a package that contains and defines the structure of the platform files necessary for this purpose, and provide the download URL for the package. To use this package 1. Create the following folder structure on an HTTP server that is accessible by your end-users workspaces. The folder structure should look like this: Create folders for your packages; the folder should be named using the first part of the package name up to the underscore (e.g. for a package named _4867.7z we will create a folder by the name ). Each update version should have its own unique folder, and the folder name must be in the format of w.x.y.z 2. Download the package and extract the files into the folder we created. The folder with the files in it should look similar to this: 10

11 3. Next to the version folders, you will need to create a file called directoryinfo.html, Open this file using notepad and type [Versions] (without the ). Use the Enter key to move to a new line, and then type the versions you have in the following format: The directoryinfo.html must be located next to the version folders, the folder should appear similar to this: 1. Log into the CCMS server as administrator. 2. Click on the account name of the account that will be updated 3. Update the URLs in the platform updates section of the account page for each account to be updated. The updated URLs should look similar to this: 4. Login as the account admin, and under the policies, create a new policy and/or update an existing policy. The newly created versions should appear in the combo boxes (please refer to the troubleshoot sections if some or all the combo boxes are empty) Future updates of platform resources 11

12 For future updates, Ceedo will provide only a single zip archive per item, containing the files for the core, brand, and settings. The zip archive will need to be extracted to a folder in the format of w.x.y.z, and that version needs to be added manually to the directoryinfo.html file. Versions that the admin does not wish to use anymore can be removed from the directoryinfo.html file. Please note, however, that removing the version number from the HTML file does not remove the usage of this version in any of the existing policies defined in CCMS, and the policies will need to be updated accordingly. Only after all policies are updated it is safe to also remove the files themselves, if there is indeed a desire to do so. Connecting to Active Directory CCMS can use your company s Active Directory as a source for Users and User-Groups for a specific account. You are able to manage your users in your Active Directory and the Ceedo for those users in your CCMS. Configuring a CCMS Account to Connect to Active Directory To configure an account to work with Active Directory log in to the account and go to the Settings. In the Active Directory page you have your default Active Directory settings: Click on Change Settings and check the Use Active Directory check-box, and then add the information of your Active Directory server. Afterwards click Save. For example: 12

13 Data Synchronization CCMS does not access the database of your Active Directory directly. The data is synced from Active Directory to CCMS (there is not syncing back of information from CCMS to Active Directory) each time you log in to CCMS. Troubleshooting System Prerequisites Page The following bulletins refer to failing tests in the System Prerequisites page: Application URL: Check that you ve set the server URL correctly in the serverconfig.php file. (see section: Editing the Configuration file) Database connection: Check the details you ve set in the serverconfig.php file (see section: Editing the Configuration file) CCMS application/database version: The version of CCMS files and database script does not match, check that imported the database script correctly. CRUD check: Check that database is configured correctly and is accessible for writing. License URL: Ceedo s activation server must be accessible from your server by HTTP (see section: Inrastructure Requirements). This can also be affected if you have a proxy, but did not configure it correctly (also check CCMS Doesn t Work With Your Proxy in the Troubleshoting section) Mod_rewrite: Check you have configured mod rewrite correctly on your Apache server Mail Protocol: Check you have configured your mail server correctly in the serverconfig.php file (see section: Editing the Configuration file) OpenSSL: Check you have installed the openssl installed correctly on the server Default platform/resources/user-interface URL: Check that your server has HTTP access for your default platform location (e.g. and 13

14 you can download files from this URL. This can also be affected if you have a proxy, but did not configure it correctly Empty Versions Combo-boxes in Settings Some of the combo-boxes are empty, but some have information: This is most likely caused by inconsistencies between thedirectoryinfo.html and your default configurations. To resolve: In the directoyinfo.html file, make sure all your versions are located under the [Versions] section. In your settings Log in as administrator, click on the account you created, and make sure Versions Section has the same text as the [ ] in the directoryinfo.html file All of the combo-boxes are empty: This is most likely because your CCMS server cannot reach the platform. To resolve: 1. Log into the CCMS server as administrator 2. Click on the problematic account 3. Copy the URL that appears under Platform, and to the browser, append / directoryinfo.html, and check that you can reach the directoryinfo.html file you created,for example, if the url is the url to check is 4. If you completed step 3 and it worked, repeat the same step from a browser in your CCMS server 5. If you completed step 3 and it did not work, check that you have configured the proxy correctly in CCMS (proxy configurations are under the serverconfig.php file) CCMS Doesn t Work With Your Proxy CCMS (and some linux distributions) can only work with web-proxy. If you are using an ISA proxy server you can use this guide to install cntlm which makes it possible for CCMS to work with ISA proxy server: 1. Download cntlm from this site: 2. Install cntlm: sudo dpkg -i cntlm_ _i386.deb 3. Edit the cntlm configuration file and add your ISA proxy information, username, password and any other information you need to access with download rights: sudo nano /etc/cntlm.conf 4. Restart cntlm so the new configurations will take affect: sudo /etc/init.d/cntlm restart 5. Edit serverconfig.php file in CCMS and point the proxy to cntlm (you don t need to fill proxy_auth : $config['proxy'] = ' :3128'; $config['proxy_auth'] = ''; Note: This guide is based on this blog post: CCMS Pages Appear Empty and Blank 14

15 Getting empty blank pages on CCMS is usually caused by file permissions issues. Please follow try these actions to solve the issue (check the issue still exists after each action) 1. Check if the System Prerequisites appears ok, if any test fails check if it is relevant. 2. If you are using Fedora or have SELINUX installed please disable it, you can find instructions at: 3. Make sure that Apache can write to the following folders: application/views/templates_c/ system/logs/ 4. Open the index.php file and change the line error_reporting(0); to: error_reporting(e_all); Open the page again, you should see error information appearing in the page, please contact Ceedo with this information. 15