Articles in this section

See more

WebDocuments Setup Guide for IceWarp Server 12.1 and later

Avatar
Mike
  • Updated
Follow

Integration with IceWarp WebDocuments allows deploying IceWarp WebDocuments in several
ways, but we recommend running it on a separate server or at least in a separate virtual machine.

Do you have IceWarp Server 12.0.X? Please find the setup guide here.

VM-Ware

ESXi VPS

With this method, you will run WebDocuments on virtual machine preconfigured by us. If you prefer to run WebDocuments on your own Virtual Machine, check also option APT repository (VM with Debian8 is required).

Import VM

Import VM

  • Download the image zip archive and extract it (VM will not run from the extracted folder)
    Version for ESX 6.5 DOWNLOAD
  • Open vSphere client (or another manager like Workstation) and deploy OVF Template
  • Open OVF Template file and click next
  • Review template details, click next
  • Fill in a name for the VM (the default value is just fine), click next
  • Select datastore and disc type - we recommend default setting (lazy zeroed). Eager zeroed will result in slower import.
    Click next to learn more about disk types at https://communities.vmware.com/message/2199576
  • Revise settings and check „Power on after deployment“, click finish
  • Click close after deployment finish
  • Manage virtual machine automatic start through VMware Workstation or vSphere WebClient - right-click hypervisor in the list in the left pane and pick "Manage AutoStart VMs..."
  • Tick the box on the left from imported VM in the Configure AutoStart dialogue.

There is no need to change anything in the image if DHCP is used. Just configure your DHCP server to assign the same IP address each time (IP reservation according to MAC)

 
Start the Virtual Machine
 

Start the Virtual Machine

Power on (if not already done during import) the Virtual Machine by selecting Start from VM Power menu or its dashboard.

 
Configure IceWarp Server
 

Configure IceWarp server

  • Obtain IP address assigned to installed machine. It should be visible on terminal (or SSH login screen) under the IceWarp logo. Open IceWarp Administration Console and insert the IP address of iwds host into "WebDocuments server connection" input located at GroupWare -> WebClient -> WebDocuments tab
  • Enable "WebDocuments Service"
  • Check that the configuration is correct by clicking "Test Connection" button (image iwdoc-iwserver-setup.jpg). "Test Connection" check will also configure iwds service for interoperation with IceWarp Server.
  • Save configuration changes by clicking on Apply button

Review TeamChat URL settings located at System -> Smartdiscover tab. URL must be reachable from iwds host. Also, IceWarp Server must be able to send out TCP packets to destination ports 8081, 80 or 443 on iwds host.

 

Hyper V

Hyper - V

This method is the easiest way for you to setup WebDocuments on Windows. With this method, you will run WebDocuments on a virtual machine preconfigured by Icewarp. If you prefer to run WebDocuments on your own Virtual Machine, check also option APT repository (VM with Debian8 is required).

Hyper - V

 
Import VM
 

Import VM

To enable Hyper-V role on your Windows Server OS to follow
https://technet.microsoft.com/en-us/library/hh846766.aspx#BKMK_SERVER
The process is quite similar on all relevant Windows Server versions.

DOWNLOAD
Win 2012 – 2012R2+
  • Download the image zip archive and extract it (VM will run in the extracted folder!)
  • Open Hyper-V Manager (located in Administrative Tools or Server Manager)
  • Click "Import Virtual Machine..." option located on top of Actions pane (on the left)
  • Browse to the location where you extracted the VM image and select the root folder containing VM files.
  • Choose import settings, both options are ok, but rather go for "Copy the virtual machine (create new unique ID)" option.
    Press "Import"

The most current version of IceWarp Server is available for Windows and the most popular Linux systems.

 
Start the Virtual Machine
 

Start the Virtual Machine

Importing will add a new virtual machine to list of all guest machines. You can start it either by right-clicking the machine or by left-clicking "Start" item in the Actions pane. Start progress is displayed in the Status column in Hyper-V Manager.

Double-clicking the machine in the list will bring up VNC console, booted VM will display IceWarp logo together with machine IP.

 
Configure IceWarp Server
 

Configure IceWarp Server

  • Obtain IP address assigned to installed machine. It should be visible on terminal (or SSH login screen) under the IceWarp logo. Open IceWarp Administration Console and insert the IP address of iwds host into "WebDocuments server connection" input located at GroupWare -> WebClient -> WebDocuments tab
  • Enable "WebDocuments Service"
  • Check that the configuration is correct by clicking "Test Connection" button (image iwdoc-iwserver-setup.jpg). "Test Connection" check will also configure iwds service for interoperation with IceWarp Server.
  • Save configuration changes by clicking on Apply button

Review TeamChat URL settings located at System -> Smartdiscover tab. URL must be reachable from iwds host. Also, IceWarp Server must be able to send out TCP packets to destination ports 8081, 80 or 443 on iwds host.

 

Linux

APT Mirror

To install WebDocuments, we recommend our users to install a clean, minimal version of Debian 9.

APT mirror

Open terminal emulator note. Commands need to be run under the 'root' account. Add apt sources of IceWarp and nodejs repository:

Check if your Debian is able to install 'contrib' and 'non-free'packages.

- you should find this line in /etc/apt/sources.list file

deb http://ftp.uk.debian.org/debian/ stretch main contrib non-free

Add apt sources of IceWarp and nodejs repository

echo "deb http://pkg.icewarp.com/debian icewarp gen2" > /etc/apt/sources.list.d/icewarp.list
echo "deb http://deb.nodesource.com/node_8.x stretch main" > /etc/apt/sources.list.d/nodejs.list

- It is also possible to use https in the source links, but in that case, apt-transport-https package HAS TO be installed first.

Install 'sudo' package

apt-get install sudo
 

Install 'dirmngr' - managing and downloading OpenPGP and X.509 certificates

apt-get install dirmngr
 

Install 'apt-transport-https' package to be able to use https source links

apt-get install apt-transport-https
 

Import signing keys into the apt keyring

apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 948AD827

gpg: requesting key 948AD827 from hkp server keyserver.ubuntu.com
gpg: key 4291FC89: public key "IceWarp Technology <sysadmin@icewarp.com>" imported
gpg: Total number processed: 1
gpg: imported: 1 (RSA: 1)


apt-key adv --keyserver keyserver.ubuntu.com --recv 68576280

gpg: requesting key 68576280 from hkp server keyserver.ubuntu.com
gpg: key 68576280: public key "NodeSource >gpg@nodesource.com<" imported
gpg: Total number processed: 1
gpg:               imported: 1  (RSA: 1)
 

Update apt database on your machine


It is required to have added system locale en_US.UTF-8, to add en_US.UTF-8 execute dpkg-reconfigure locales
and check the checkbox for this locale

apt-get update && apt-get upgrade

...
...
Hit http://pkg.icewarp.com icewarp InRelease
Hit https://deb.nodesource.com stretch InRelease
Hit http://pkg.icewarp.com icewarp/gen1 amd64 Packages
Get:14 https://deb.nodesource.com stretch/main amd64 Packages [964 B]
Get:15 https://deb.nodesource.com stretch/main Translation-en_US [162 B]
Get:16 https://deb.nodesource.com stretch/main Translation-en [162 B]
Get:17 https://deb.nodesource.com stretch/main Translation-en_US [162 B]
Get:18 https://deb.nodesource.com stretch/main Translation-en [162 B]
Get:19 https://deb.nodesource.com stretch/main Translation-en_US [162 B]
Get:20 https://deb.nodesource.com stretch/main Translation-en [162 B]
Get:21 https://deb.nodesource.com stretch/main Translation-en_US [162 B]
Get:22 https://deb.nodesource.com stretch/main Translation-en [162 B]
Get:23 https://deb.nodesource.com stretch/main Translation-en_US [162 B]
Get:24 https://deb.nodesource.com stretch/main Translation-en [162 B]
Fetched xxx kB in xs (xx.x kB/s)
Reading package lists... Done
 

Install icewarp-webdocuments package

apt-get install icewarp-webdocuments

This package will install all necessary dependencies, so after approximately twenty minutes you will have configured and running backend for your web documents. The last line of the script output is the actual IP address of iwds host which is needed in the next step, you can, however, obtain an IP address in any common way.

 

Configure IceWarp server

  • Obtain IP address assigned to installed machine. It should be visible on terminal (or SSH login screen) under the IceWarp logo. Open IceWarp Administration Console and insert the IP address of iwds host into "WebDocuments server connection" input located at GroupWare -> WebClient -> WebDocuments tab
  • Enable "WebDocuments Service"
  • Check that the configuration is correct by clicking "Test Connection" button (image iwdoc-iwserver-setup.jpg). "Test Connection" check will also configure iwds service for interoperation with IceWarp Server.
  • Save configuration changes by clicking on Apply button
  • Restart the Groupware service

Review TeamChat URL settings located at System -> Smartdiscover tab. URL must be reachable from iwds host. Also, IceWarp Server must be able to send out TCP packets to destination ports 8081, 80 or 443 on iwds host.

Related articles

Comments

0 comments

Please sign in to leave a comment.