FOR PARALLELS / PLESK PANEL

Transcription

1 WEB2CS INSTALLATION GUIDE FOR PARALLELS / PLESK PANEL XandMail 32, rue de Cambrai PARIS - FRANCE Tel : +33 (0)

2 TABLE OF CONTENTS 1. INSTALLING WEB2CS RETRIEVING THE WEB2CS APPLICATION PACKAGE FROM THE APS CATALOG OPEN THE APS CATALOG ( IN YOUR BROWSER SEARCH FOR THE XANDMAIL PRODUCTS DOWNLOAD THE MOST RECENTLY PUBLISHED PACKAGE ADDING THE WEB2CS PACKAGE TO THE SERVER S APPLICATION VAULT CONNECT TO THE SERVER ADMINISTRATION INTERFACE EXPAND THE SERVER MANAGEMENT MENU AND DISPLAY THE TOOLS & SETTINGS PAGE DISPLAY THE APPLICATION VAULT CLICK ON MY APPS CLICK ON ADD APP SELECT THE WEB2CS APPLICATION PACKAGE FROM YOUR DISK, CHECK THE MAKE AVAILABLE TO CUSTOMERS CHECKBOX AND CLICK OK INSTALLING THE WEB2CS APPLICATION IN A DOMAIN CONNECT TO YOUR DOMAIN S ADMINISTRATION INTERFACE LOOK FOR THE XANDMAILWEB2CS V4 FOR PLESK PANEL APPLICATION CLICK ON INSTALL TYPE THE NAME OF THE SUBDIRECTORY IN WHICH TO INSTALL, CORRESPONDING TO THE INSTALLATION URL EVENTUALLY MODIFY THE SETTINGS CLICK INSTALL CLICK ON THE PUBLIC ACCESS ENTRY POINT LINK UPDATE THE APACHE SERVER S CONFIGURATION ACCESS THE ADMINISTRATION INTERFACE HIDE THE INSTALLATION INSTRUCTIONS PAGE MANAGING MULTIPLE DOMAINS ON THE SAME INSTALLATION ONE INSTALLATION FOR ONE DOMAIN ONE INSTALLATION FOR SEVERAL DOMAINS, EACH WITH ITS OWN LEVEL OF FEATURES ONE INSTALLATION FOR SEVERAL DOMAINS, ALL WITH THE SAME LEVEL OF FEATURES ADDING A NEW DOMAIN ALIAS TO THE INSTALLATION Click on Web2CS instances for domain aliases Click on Add Web2CS instances for domain aliases Click on Show All Settings Input the domain alias Click OK to create the domain specific subdirectory in the Web2CS installation Click Select Columns in the list of managed domain aliases REMOVING A DOMAIN ALIAS FROM THE INSTALLATION 34 2

3 MAKING A BACKUP OF THE DOMAIN SPECIFIC DATA USING THE WEB2CS APPLICATION DISPLAY THE LOGIN PAGE CHANGE THE APPLICATION COLORS AND LOGO Upload a logo Change the background color APPLICATION CAPABILITIES: LIMITED OR NOT? INSTALL AN UPGRADE LICENSE CHANGE THE RSS FEED TROUBLESHOOTING USING AN SMTP SERVER THAT REQUIRES AUTHENTICATION UPGRADING FROM XANDMAILWEB2CS V3 TO XANDMAILWEB2CS V4 FOR PLESK PANEL UPGRADING FROM XANDMAILWEB2CS V4R1B10 TO XANDMAILWEB2CS V4R1B LOGIN DOES NOT WORK ON A 64 BITS SERVER UNINSTALLING WEB2CS UNINSTALLING WEB2CS FROM A DOMAIN REMOVING WEB2CS FROM THE SERVER 51 3

4 1. INSTALLING WEB2CS The Web2cs application has been packaged for installation on servers managed with Parallel s Plesk Panel RETRIEVING THE WEB2CS APPLICATION PACKAGE FROM THE APS CATALOG OPEN THE APS CATALOG ( IN YOUR BROWSER 4

5 SEARCH FOR THE XANDMAIL PRODUCTS If the XandMail products do not show on the current page, search for them: 5

6 DOWNLOAD THE MOST RECENTLY PUBLISHED PACKAGE Click on the Download button of the XandMailWeb2cs V4 for Plesk Panel package. Store the application s installation package on your disk. 6

7 1.2. ADDING THE WEB2CS PACKAGE TO THE SERVER S APPLICATION VAULT CONNECT TO THE SERVER ADMINISTRATION INTERFACE The connection is normally done in HTTPS, using the port

8 EXPAND THE SERVER MANAGEMENT MENU AND DISPLAY THE TOOLS & SETTINGS PAGE 8

9 DISPLAY THE APPLICATION VAULT 9

10 CLICK ON MY APPS 10

11 CLICK ON ADD APP 11

12 SELECT THE WEB2CS APPLICATION PACKAGE FROM YOUR DISK, CHECK THE MAKE AVAILABLE TO CUSTOMERS CHECKBOX AND CLICK OK Note: If you have direct access to the APS catalog from your Plesk Panel interface, you can directly install the Web2cs package, without first downloading it to your disk. 12

13 XandMail s Web2cs application is now available on the server for installation on a domain. 13

14 1.3. INSTALLING THE WEB2CS APPLICATION IN A DOMAIN CONNECT TO YOUR DOMAIN S ADMINISTRATION INTERFACE The connection is normally done in HTTPS, using the port

15 LOOK FOR THE XANDMAILWEB2CS V4 FOR PLESK PANEL APPLICATION The XandMailWeb2cs V4 for Plesk Panel application may appear directly on the Home page, in the list of featured applications: 15

16 If it is available, click on its title to display its description: Please take note of the information available in the product description: It runs only on Linux platforms. We recommend installing it in a separate subdirectory of your website (it will not run correctly in the root of the website, due to Plesk restrictions). An installation log file called installation.log (or upgrade.log in case of upgrade) is created during installation in the root directory of the installed site. Please consult it after installation, as it contains instructions on how to make your installation work and be secure. 16

17 If the XandMailWeb2cs V4 for Plesk Panel application is not immediately visible, click on Install Applications: If the XandMailWeb2cs V4 for Plesk Panel application is listed in the Featured Applications, click on its title to display its description (screen shot on the previous page). 17

18 Otherwise, click on All Available Applications, then on in the Collaboration series of links. The XandMailWeb2cs V4 for Plesk Panel application should be listed. Click on its title to display its description (screen shot on the second previous page). 18

19 CLICK ON INSTALL Click on the link to read the license agreement, then check the I accept checkbox and click Next. 19

20 TYPE THE NAME OF THE SUBDIRECTORY IN WHICH TO INSTALL, CORRESPONDING TO THE INSTALLATION URL We recommend installing it in a separate subdirectory of your website (it will not run correctly in the root of the website, due to Plesk restrictions). The default subdirectory is called web2cs. However, if you will be hosting and managing in a single installation several domains (see the domain management section below), remember that this name will appear in the webmail access URLs used for the various domains: or for example. 20

21 EVENTUALLY MODIFY THE SETTINGS It is at this stage that you will provide the left part of the administrator address if you do not wish to use the default address for the administrator. If you will be hosting and managing in a single installation several domains (see the domain management section below), remember that you will have to create a mailbox with this administrator address for each managed domain. You can also change here default language and time zone, as well as the IP and port of the mail server (IMAP) and message sending server (SMTP), and define the IMAP4 system folder names (important if you have previously created system folders with another mail application, to avoid creating new folders and reuse the existing ones). 21

22 CLICK INSTALL You will see a new element in the installation result page, starting from version : the Provided services link, called Web2CS instances for domain aliases. This service will be explained in the following pages. 22

23 CLICK ON THE PUBLIC ACCESS ENTRY POINT LINK The application s installation instructions page is displayed. Depending on your server s configuration, the login may or may not work immediately at this stage. If it does not work, you need to add some configuration rules to the Apache server in order to indicate that CGIs should be allowed to execute. This page shows the necessary instructions. It is best to prevent users from accessing and breaking your application or your server. So even if login works immediately, we strongly recommend adding the security configuration to the Apache server. 23

24 UPDATE THE APACHE SERVER S CONFIGURATION In order to make your installation secure, you must include the [domain virtual host directory]/httpdocs/[installation subdirectory]/vhost.conf file into the [domain virtual host directory]/conf/vhost.conf file: Include [domain virtual host directory]/httpdocs/[installation subdirectory]/vhost.conf After that, you need to call the following command: /usr/local/psa/admin/bin/httpdmng --reconfigure-all in order to tell the Apache server to use the updated configuration. The full path that should replace [domain virtual host directory] is indicated in the installation.log file located in the root directory of your Web2cs application. Note: Including the vhost.conf file into the Apache server s configuration is also important if you want to use both domain name]/web2cs and domain name]/web2cs URLs, as the www. [your domain name] directory is created as a symbolic link and the Apache server must be told to follow the symbolic links under the domains directory. Note: If you want to use other subdomain names to access Web2cs, simply create a symbolic link similar to the www. [your domain name] in the domains directory. 24

25 ACCESS THE ADMINISTRATION INTERFACE The application administrator defined during the installation process ( postmaster by default) has access to the administration interface, using his login and password. The URL of that administration interface is indicated in this installation instructions page, but will no longer be available in the user interface once the installation instructions page is hidden (which is the next step). If you forget it, however, it will still be indicated in the installation.log file located in the root directory of the installed application. The URL is [application installation URL]/admin/index.html. In this administration interface, you will be able to: Replace the XandMail logo with your own logo Change the background color of the application Change the newsfeed URL to provide your own information to your users Manage the application s license The pages available in the administration interface are also accessible to the administrator in the Web2cs main interface. When you are through with your administrator configuration, clicking on the Web2.0 Communication Solution link on the login page will get you directly to the Web2cs login page. 25

26 HIDE THE INSTALLATION INSTRUCTIONS PAGE Once the login works and you have added the security configuration parameters to the vhost.conf file, you can hide the installation instructions page by clicking on the When the login works correctly, click here to hide these instructions. link. Hiding the installations instructions page will display in its place the normal login page. 26

27 1.4. MANAGING MULTIPLE DOMAINS ON THE SAME INSTALLATION ONE INSTALLATION FOR ONE DOMAIN This is the only possibility available in versions prior to In this type of installation, you install the application once for each and every domain which needs the application. Each installation requires its own license to enable the features required for that domain, and uses up a lot of disk space as every file is duplicated for each domain: 27

28 ONE INSTALLATION FOR SEVERAL DOMAINS, EACH WITH ITS OWN LEVEL OF FEATURES Starting from version , it is possible to use a single installation to manage several domains. In this type of installation, you install the application only once, for the first domain. Each subsequent domain can be added / removed through the Web2cs instances for domain aliases service available in the application management page on your Plesk Panel. Each domain still needs its own license to enable the features required for that domain, but it uses up much less disk space as only the domain specific files are separated for each domain: 28

29 ONE INSTALLATION FOR SEVERAL DOMAINS, ALL WITH THE SAME LEVEL OF FEATURES Starting from version , it is possible to use a single installation to manage several domains. In this type of installation, you install the application only once, for the first domain. Each subsequent domain can be added / removed through the Web2cs instances for domain aliases service available in the application management page on your Plesk Panel. A global license is installed to enable a set of features which will be available to all the domains managed by that installation. Only the domain specific files are separated for each domain: 29

30 ADDING A NEW DOMAIN ALIAS TO THE INSTALLATION The installation of the Web2CS application is made on the primary domain. This can be a valid domain managed by one of your customers, or it can be restricted to your own use as the server administrator. We recommend this second solution, as it will prevent your customer from putting in peril (voluntarily or by mistake) the Web2CS application used by other domains than his own. In order for each domain to have his private access to Web2CS, you will have to create a domain alias pointing to the primary Web2CS domain for each of the customer domains. For example, you have installed on PrimaryDomain.com. Your first customer purchases domain1.net from you. You will create a domain alias called mail.domain1.net (or any other name that you fancy) pointing to PrimaryDomain.com, and provide this mail.domain1.net alias to the Web2CS service CLICK ON WEB2CS INSTANCES FOR DOMAIN ALIASES 30

31 CLICK ON ADD WEB2CS INSTANCES FOR DOMAIN ALIASES CLICK ON SHOW ALL SETTINGS INPUT THE DOMAIN ALIAS If you have installed in a directory other than web2cs, do not forget to modify the default Web2cs installation directory indicated here. 31

32 CLICK OK TO CREATE THE DOMAIN SPECIFIC SUBDIRECTORY IN THE WEB2CS INSTALLATION. The service access entry points give access to the normal login page (URL to be provided to regular users of the domain) and to the administration login page (URL to be provided to the domain s administrator). You can use these URLs to test the correct installation of the new domain s web2cs. Click Up Level to get back to the list of managed domain aliases CLICK SELECT COLUMNS IN THE LIST OF MANAGED DOMAIN ALIASES 32

33 Select Domains in the left hand side box. Click on the arrow to move it to the right hand side box. Click Ok. 33

34 Now the domain aliases are listed in the list: REMOVING A DOMAIN ALIAS FROM THE INSTALLATION Removing a domain alias from the installation will delete the entire user data associated to that domain alias. Simply select the domain alias to delete and click Remove: MAKING A BACKUP OF THE DOMAIN SPECIFIC DATA To backup all the domain specific data of your web2cs installation, simply backup the domains directory. 34

35 1.5. USING THE WEB2CS APPLICATION DISPLAY THE LOGIN PAGE Type the installation URL in your favorite browser. Type an address and password that exist on your server and click on Login to use the application. Note: On some Plesk servers, the instructions given by the installation script to the server, in order to make the the HTTP server execute the application binaries instead of downloading them, are for some reason not effective. This results in your being unable to login to the application. Updating the apache server s configuration as explained in section is usually enough to solve the problem. 35

36 CHANGE THE APPLICATION COLORS AND LOGO In order to change the application colors and logo, you must login either to the Web2cs or its administrator interface using the administrator account ( postmaster by default). 36

37 In the application menu (located on the left), click on Administration. You will see the access points to the three administration pages: License Management Customization Manage RSS feed 37

38 Click on Customization You can in this page: Upload a logo Change the background color of the interface 38

39 UPLOAD A LOGO The format of the image for the logo must be in png format (.png extension) and not exceed the size of 100 KB. You can replace the logo for: the Web login page the Web interface (Web2cs and HTML) Mobile interface You have to respect the following rules: The name for the Web login page logo must be "logo_big.png" The name for the Web interface logo must be "logo_small.png" and the dimension should be less than 80x250 pixels The name for the mobile interface logo must be "logo_mobile.png" and the dimension should be less than 46x150 pixels Start by uploading the logo for the Web interface (logo_small.png) as it will immediately appear at the top of the page. 39

40 If the new logo does not immediately appear, you might have to empty the cache of your browser and re-login. In the same way, upload then the Web login page logo and the Mobile interface logo. To see the Web login page s new logo, you will need to logout. To see the Mobile interface logo, you will need to connect with a Mobile phone. 40

41 CHANGE THE BACKGROUND COLOR In the customization administration page, you can also change the background color of the application to better match your company colors. You can either clear on the pre-defined colored squares (pink, yellow, green, blue, grey) or you can specify your own color using the standard hexadecimal color format: #RRGGBB (RR = red, GG = green, BB = blue each of the 3 colors can take hexadecimal values between 00 and FF). If you specify your own color, click on the Preview link to see the result: Once you are happy with the chosen color, do not forget to click on the Save button 41

42 APPLICATION CAPABILITIES: LIMITED OR NOT? The free basic version of the application is limited to using the messaging functions together with the address book. But the Web2cs application is capable of much more which, as service administrator, you might think about providing to your users. Thus the administrator account can see the full set of modules and options in the menus. Each of these modules or options can be enabled with a specific license, without having to reinstall the application. When you browse through a disabled module in the menu, a popup will indicate it and provide at the same time links to more information and pricing on that module. 42

43 Of course, a regular (non-administrator) user will not see those modules in the menu as long as they are disabled. So the application capabilities are limited in the free basic pack, but can easily be augmented by purchasing an upgrade license. 43

44 INSTALL AN UPGRADE LICENSE In order to install an upgrade license, you must login either to the Web2cs or its administrator interface using the administrator account ( postmaster by default). In the application menu (located on the left), click on Administration. You will see the access points to the three administration pages: License Management Customization Manage RSS feed Click on License Management. In this page, you can see which type of license you have purchased (Free basic license by default), the numbers of users available, which products are being used and when the license will expire. 44

45 When you receive an upgrade license, simply come to this page, click on the Upload a license file button and choose the part00.dat file you received after your purchase. A popup will list the content of the new license, waiting for your confirmation to apply the new license file. Once you click on the Apply license file button, the new license is installed. Logout and login again to have the application use the new license. 45

46 CHANGE THE RSS FEED In order to change the RSS feed, you must login either to the Web2cs or its administrator interface using the administrator account ( postmaster by default). In the application menu (located on the left), click on Administration. You will see the access points to the three administration pages: License Management Customization Manage RSS feed Click on Manage RSS feed. Provide a new RSS feed URL. Click Save. The RSS feed is updated. Go to the Desktop page to see the new RSS feed. 46

47 1.6. TROUBLESHOOTING USING AN SMTP SERVER THAT REQUIRES AUTHENTICATION If you are using an SMTP server that requires authentication and have installed a 3.2.x Web2cs package, you need to add two configuration parameters in order to be able to send messages. 1. Edit the cgi-bin/cgi.cnf configuration file. 2. Search for the first occurrence of the disable_view_links parameter 3. Add the following parameters on the next lines (so that they are part of the #security management parameters) : smtp_auth=99 smtp_auth_direct=1 47

48 UPGRADING FROM XANDMAILWEB2CS V3 TO XANDMAILWEB2CS V4 FOR PLESK PANEL If you have previously installed XandMailWeb2cs version 3.2.x, your users already have address book data and will want to keep their contacts in the new XandMailWeb2cs V4 for Plesk Panel version. Follow these steps to upgrade your installation: 1. Backup the user data from the existing installation The user data is located in subfolders of the folders directory. Make a copy or a compressed file of the content of the folders directory. Make sure to announce to your users that their address book data will be copied at that time, so that they will not add or modify them afterwards 2. Install XandMailWeb2cs V4 for Plesk Panel You should install in a new directory if you do not want to interrupt the service. This way, your users can keep working with version 3 while you prepare version 4. If you wish to install in the same directory, the service will be interrupted during the time it will take to make the installation. You must first uninstall the v3 version (after making a backup of the folders directory) before installing the v4 using the same folder name. 3. Copy the user data on the new installation Copy the content of the folders directory, taken from the v3 installation, into the folders directory of the v4 installation. 4. Publish the access URL of the v4 version The installation is ready for work. You can change the access URL so that users will now use the newer version. 48

49 UPGRADING FROM XANDMAILWEB2CS V4R1B10 TO XANDMAILWEB2CS V4R1B13 If you have previously installed XandMailWeb2cs version , your users already have address book data and will want to keep their contacts in the new XandMailWeb2cs version Follow these steps to upgrade your installation: 1. Backup the user data from the existing installation using version or lower The user data is located in subfolders of the folders directory. Make a copy or a compressed file of the content of the folders directory. Make sure to announce to your users that their address book data will be copied at that time, so that they will not add or modify them afterwards 2. Install XandMailWeb2cs V4 for Plesk Panel version or more recent You should install in a new directory if you do not want to interrupt the service. This way, your users can keep working with the old version while you prepare the newer version. If you wish to install in the same directory, the service will be interrupted during the time it will take to make the installation. You must first uninstall the old version (after making a backup of the folders directory) before installing the newer version using the same folder name. 3. Copy the user data on the new installation Copy the content of the folders directory, taken from the old installation, into the folders subdirectory of the domains/[your domain name] directory of the new installation. 4. Upload the license file on the domain s new installation If the domain was using a purchased license, you must login to the new installation using the domain s administrator account and upload the license file of that domain. 5. Publish the access URL of the new version The installation is ready for work. You can change the access URL so that users will now use the newer version. 49

50 LOGIN DOES NOT WORK ON A 64 BITS SERVER 32 bits application binaries cannot execute on 64 bits servers if they are not recognized as executable files. So on 64 bits servers, it is necessary to install some system libraries used by 32 bits applications, so that they will execute correctly. You can check whether the application will work or not by going to the cgi-bin directory and asking for the binaries version. Type:./webmail -id It should display the version and copyright notices. If that succeeds, there is nothing to do. If you get an error /lib/ld-linux.so.2: bad ELF interpreter, you need to install the libgcc, glibc, and maybe also the libstdc++ and libncurses libraries. The command to see which library is missing is: ldd webmail The command to find out in which package to find the missing library is: yum whatprovides [the library name] The command to install the missing package is: yum install [the package name] After you have installed all missing packages and ldd finds all the dynamically linked libraries, ask once again for the binaries version. If that succeeds, try to login again from the login page in your browser. 50

51 2. UNINSTALLING WEB2CS We really do hope that you will not need to uninstall our application, except maybe to replace it with a more recent version of our products 2.1. UNINSTALLING WEB2CS FROM A DOMAIN 1) Connect to your server 2) Edit the [domain virtual host directory]/conf/vhost.conf file 3) Remove the Include xxx configuration line related to the application to remove 4) Call the following command to tell the Apache server to use the updated configuration: /usr/local/psa/admin/bin/httpdmng --reconfigure-all 5) Connect to your domain s administration interface 6) Click on Manage Installed Applications 7) Click on the Uninstall link of the application 8) Confirm the request to uninstall the application 2.2. REMOVING WEB2CS FROM THE SERVER 1) Connect to your server s administration interface 2) Open the server Management menu and display the Tools & Utilities page 3) Click on Application Vault 4) Click on Uploaded Apps 5) Check the XandMail Web2cs application 6) Click on the Remove button 7) Confirm the removal The Web2cs application is now no longer present on the server. 51