Kerio Workspace Step-by-Step Kerio Technologies
2011 Kerio Technologies s.r.o. All rights reserved. This guide provides detailed description on Kerio Workspace, version 1.0.0. All additional modifications and updates reserved. For current versions of the product and related manuals, check http://www.kerio.com/workspace/download/. Information regarding registered trademarks and trademarks are provided in the appendix A.
Contents 1 Introduction ................................................................... 2 System requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.1 Hardware requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 2.2 Supported operating systems and browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 3 Installation . . . . . . . . .
7 Used open-source software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 A Legal Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1 Introduction Kerio Workspace is a server software for companies which wish their employees spend less time looking for documents and more time collaborating. Use your standard web browser to work with Kerio Workspace. With an easy and intuitive web interface, you can create and organize pages for sharing documents, texts, multimedia and so on.
Chapter 2 System requirements 2.1 Hardware requirements Hardware requirements for PC: • CPU 1GHz • 512 MB RAM • 500 MB of free disk space for installation • 20 GB of free disk space for data store Hardware requirements for Mac: • Intel CPU 1GHz • 512 MB RAM • 500 MB of free disk space for installation • 20 GB of free disk space for data store Hardware requirements for Mobile Client: • iPhone 3G/3GS/4G s iOS 4 2.
2.2 Supported operating systems and browsers The product can be installed only on Mac computers with Intel processor. List of up-to-date versions (or distribution packs) of the operating systems supported by Kerio Workspace can be found at the Kerio Technologies website. Each operating system requires an appropriate installation package. For any type of installation package file, check http://www.kerio.com/workspace/download/.
Chapter 3 Installation Once a corresponding installation package is downloaded, you may start the installation. Installations differ by operating system. 3.1 Windows Once the installation package is downloaded, run the installation under a user with administration rights for the operating system. Kerio Workspace application requires the installation of Java Runtime Environment. In case Java Runtime Environment is missing on the system, the wizard offers you its immediate installation.
3.3 Linux launchctl load -w /Library/LaunchDaemons/com.kerio.workspace.rendering.plist Use the following commands to stop the service: launchctl unload -w /Library/LaunchDaemons/com.kerio.workspace.application.plist launchctl unload -w /Library/LaunchDaemons/com.kerio.workspace.rendering.plist Note: The -w parameter in all the commands saves the settings (enable/disable) into your system. If you stop the service without using this parameter, it will be started automatically again after the system restart.
Installation Before that, make sure that there is an active repository for Java Runtime Environment on the system. Some system versions have the repository turned off (for example, on Ubuntu 10.04, it can be found in repository partner, or on Debian 5.0, it can be found in repository non-free). Activate the repository in Gnome GUI or using the terminal: in file /etc/apt/sources.
3.5 Admin Account All the application data are saved to the store folder which can also be found in the installation folder of Kerio Workspace. 3.5 Admin Account In the dialog for creating the first user account, set user name, whole name, email address and password. In the data store dialog window, select the path to the folder you want to use for storing all user data created and processed by the Kerio Workspace application. The dialog contains information about free space on the target drive.
Chapter 4 Kerio Workspace Administration Interface Use one of the following addresses to access the web administration login page: https://server.name:4060/admin or https://computer.IP.address:4060/admin Figure 4.1 Welcome page The Logout option enables you to log out of the interface. 4.1 Users If you need to find a particular item, use the Search function. The list of user accounts displays information in the following columns: Username, Full name and Description.
4.1 Users Figure 4.2 The Users Section Add users Click on Add. 1. On the General tab, enter the Username, Full Name, Description (for informative purposes), Email Address and Password (which needs to be confirmed). You can disable the account by unchecking the Account is enabled option. You can temporarily disable user accounts in the edit dialog of each account. For example, if a new employee is about to take up work in your company, you can prepare their user account in advance.
Kerio Workspace Administration Interface Warning: The Username and Full name fields are obligatory! 2. Go to the Rights tab and set the administration rights. There are three levels of access rights (see the figure): Figure 4.4 3. Add User — Rights tab Once you are satisfied with the settings, click the OK button to create the user. 4.2 Directory Service This section describes the directory service settings. Figure 4.
4.2 Directory Service Apart from the internal database of user accounts, Kerio Workspace can also import accounts and groups from a directory service. Active Directory (Windows Server) and Open Directory (Mac OS X Server) are currently supported. Using LDAP, user accounts can be managed from one location. This reduces possible errors and simplifies administration. Example: A new employee was introduced to the company. Check the following example: 1. A new account has been created in Active Directory. 2.
Kerio Workspace Administration Interface 1. In the Directory Service dialog, check the Map user accounts from a directory service option and fill in the following data: • Directory Service Type — select the directory service type from the dropdown menu • Domain Name — enter the name of the domain 2. Next, define the directory service sources: • Connect to directory servers looked up in DNS (SRV records) — DNS records are used to look up directory servers.
4.4 Web Server Ports Figure 4.7 SMTP server settings 4.4 Web Server Ports In section Web Server Ports, set the ports for unsecured (HTTP) and secured (HTTPS) connections. Figure 4.8 Web Server Ports Kerio Workspace listens on all network interfaces and configured addresses (IPv4 or IPv6). If you do not wish to use the IPv6 addresses, disable them on your system. 4.
Kerio Workspace Administration Interface to establish a connection with the server, whereas the private (decrypting) key is available only to the server and must remain secret. The client, however, also needs to be able to identify the server (to find out if it is truly the server and not an impostor). That is what a certificate is for. A certificate contains a public server key, the name of the server, validity period and other data.
4.6 Backup a path to a file with the private key (a file with the .key extension) and to a file with the certificate (a file with the .crt extension). Select a certificate and click the Show Details button to display detailed information. You may export a selected certificate with the Export button, or delete it by clicking the Remove button. The Set as Active option activates the certificate which will be used for incoming HTTPS connections. 4.
Kerio Workspace Administration Interface In the Backup scheduling section, you may create and set the backup tasks. Check the Enable message store and configuration recovery backup option to activate it. Kerio Workspace offers two types of backup tasks: full backup and differential backup. The full backup stores all files and settings in Kerio Workspace. The differential backup stores only files changed or newly created since the previous full backup.
4.7 Update Checker In the advanced backup configuration, define the number of saved backups. If this number is reached, the oldest file will be deleted upon creating a new backup. 4.7 Update Checker In the Update Checker section, you may set parameters for the product’s updates. Figure 4.11 The Update Checker Section This section includes information about the last update and time since the last update. To download new updates automatically, check the Automatically check for new versions option.
Kerio Workspace Administration Interface 4.8 Logs Logs are files where information about certain events (e.g. error and warning reports, debugging information, etc.) are recorded. Each item is represented by one row starting with a timestamp (date and time of the event). Messages in logs are displayed in English for every language version of Kerio Workspace.
4.8 Logs • Format — the log may be saved as in plain text (TXT ) or in hypertext (HTML). If the log is saved in HTML, the encoding and colors (where highlighting was used) will be saved. If it is expected that the log would be processed by a script, it might be better to save it in plain text. • Source — the option enables saving of the entire log or a selected part of the text. The Only selected rows is active only if you select a part of the text with cursor. The selected part can be saved.
Kerio Workspace Administration Interface Figure 4.15 File Logging • Keep at most ... log file(s) — define how many log files will be stored. The oldest file will be cleared after each rotation. The External Logging tab: Open the External Logging dialog to set logging to a Syslog server or to a file. The three options can be combined. Figure 4.
4.8 Logs • Enable Syslog logging — use this option to enable logging to a Syslog server • Syslog server — DNS name or IP address of the particular Syslog server. • Facility — this entry helps Kerio Connect recognize where a log came from (Syslog server can receive logs from various sources). • Severity — set how important the log is (Syslog enables filtering of logs with respect to their severity). Clear log Clears the log (information is also removed from the appropriate file).
Kerio Workspace Administration Interface Server log All technical information is stored in this log. This includes, for example, error logs which are used by technical support and developers of this product.
Chapter 5 Web Client (User Interface) Use one of the following addresses to access the web user interface login page: http://workspace_server_name (https://workspace_server_name) or http://server_IP_address (https://server_IP_address). The interface allows you to create pages, sort them into folders and spaces and share them with other users. This chapter provides information about the user client, its functions and work with the individual components. 5.
Web Client (User Interface) In each space, you can create other nested spaces. Nested spaces or pages in them inherit rights from their parent spaces (for more information on pages, see the next chapter in this manual). To created a new space of the highest level click on the Create a New Space button. Enter the name for the space. Enter description for better reference. Figure 5.
5.2 Pages Figure 5.3 User’s space 5.2 Pages In every space, you may create pages and share them with other users. Each page may include as many components as you like. The components types are described in the following chapters. Creating a New Page To create a new page, click Create New Page in any space to which you have the Contributor or Admin rights (see chapter 5.4). Pages allows you to set a basic layout (the Layout option in the tools menu).
Web Client (User Interface) Figure 5.4 Page layout and color scheme edit Figure 5.5 New page The width of the columns can be changed by dragging the relevant border. You may add various components to the page. If the document is empty, icons for inserting particular components are displayed (see picture 5.
5.2 Pages you want to insert another component. The insert component option is displayed which opens the menu with components to insert. Figure 5.6 Insert component options The following components may be inserted: • Text — inserts a formattable text field which may be edited in an editor • Image • Video — inserts a video file in FLV format • Mashup — inserts an element from an external site via HTML code • Link List • File Library The inserted component appears in the appropriate place on the page.
Web Client (User Interface) Figure 5.7 Component controls Figure 5.8 Common option in the context menu • Hide Title/Show Title — displays or hides the title of the component. • Background Color— allows to select the color of the component background. Transparent background can also be set. • Cut — removes the component from the document and places it into the clipboard. You can insert the component into another page using the Insert option in the double arrow menu of the page.
5.2 Pages Figure 5.9 Editing text in the format editor The Image Component A function for inserting images. Click the Select Image File button to open a dialog and select the image file. The video is uploaded into the component area. The icon in the bottom right corner allows you to change the area size; the image adjusts to the window in scale up to its original size. Figure 5.10 The Image component context menu options To replace the image, use the Upload New Image option.
Web Client (User Interface) *The Mashup Component Sometimes it is convenient or necessary to insert external content. It is useful especially for Internet video files. Insert the component and use the Enter a HTML code option. In the field opened, enter the HTML code of the content to be displayed. You can acquire the code on the source site. The inserted HTML code is displayed in the field. Figure 5.11 Code of the external content Figure 5.
5.3 Using File Libraries You may change the content by clicking the Change the HTML Code option. The Link List Component Improve your documents by inserting special link lists. The Create New Link option opens a dialog where you enter the name of the link (i.e. the text to be displayed) and URL address of the link which will open the appropriate site. You may delete and edit the links later. Placing the mouse pointer on the link displays a little arrow which opens a menu with edit and delete options.
Web Client (User Interface) Note: If you upload a file which has already been uploaded to the same file library, you have the option to overwrite the original one. A new version of the file is created. The Create New Folder option allows you to sort the files in each file library. If necessary, you may rename the folders and upload new files into them. You may also delete them.
5.4 Sharing Possibilities and Features Figure 5.16 File history in a File Library and its menu You may view and edit a file with Desktop Client on Windows and Mac OS X operating systems. It enables you to open the files in programs on your computer associated with the particular file types. For detailed information, see chapter 6. 5.
Web Client (User Interface) Figure 5.17 Sharing settings and assigning rights to specific users 5.5 Additional Functions of the User Interface Kerio Workspace offers you a range of additional useful functions: • Drag and Drop — you can drag and drop spaces or pages to and from your Favorites in the hierarchic tree on the left • Search — enter the text in the search field in the upper bar and search the workspace for the desired document. • Deleted Items — all the deleted items stay saved on the server.
5.5 Additional Functions of the User Interface Figure 5.18 The Tools Section • Add to Favorites,Remove from Favorites — this option in the drop-down menu of a space or page adds the space or page in the user’s favorites section or removes it. • Send Link — each space or page has an option to send the link to other users. A simple dialog with a message is opened. Enter recipients’ email addresses and modify the message if you desire. Figure 5.
Web Client (User Interface) You can also you the Drag and Drop function which allows you to change the order of spaces and pages in the hierarchical tree on the left. Drag and drop an item to a new position.
5.7 Mobile Client Figure 5.21 Following the page activity 5.7 Mobile Client Kerio Workspace currently supports viewing on the iPhone devices. You cannot edit files using your phone.
Chapter 6 Desktop Client Kerio Workspace Desktop Client is an optional tool for Windows and Mac OS X operating systems. While the web interface allows you to preview only some of the files in file libraries (see above 5.3), the desktop client provides the preview and edit option in the programs associated with the particular files on your desktop. This makes it possible to edit the documents in your favorite programs. 6.
6.2 Using Desktop Client Figure 6.2 Desktop client menu with list of opened files for future modifications. Keeping the file opened in the desktop client allows you to open it again or save it to the server later by right-clicking the client icon. Before you decide to save the file on the server or keep it in the desktop client, you can add a commentary about your changes which will be displayed in the news feed section of all users who has the page or space among their favorite items.
Desktop Client Figure 6.
Chapter 7 Used open-source software Antisamy Antisamy is an HTML/CSS validation library. Copyright 2007-2008 Arshan Dabirsiaghi, Jason Li ANTLR ANTLR, ANother Tool for Language Recognition, is a language tool that provides a framework for constructing recognizers, interpreters, compilers, and translators from grammatical descriptions containing actions in a variety of target languages. Copyright 2003-2008 Terence Parr Copyright 1999-2001 Free Software Foundation, Inc.
Used open-source software Apache Commons Compress Apache Commons Compress defines an API for working with tar, zip and bzip2 files in Java. Copyright 2002-2009 The Apache Software Foundation Apache Commons FileUpload Apache Commons FileUpload provides file upload capability for servlets and web applications. Copyright 2002-2008 The Apache Software Foundation Apache Commons IO Apache Commons IO is a collection of I/O utilities for Java.
Copyright 2001-2004 Unicode, Inc. Copyright 2009 www.imdict.net Apache PDFBox Apache PDFBox is an open source Java PDF library for working with PDF documents. Copyright 1985 - 2007 Adobe Systems Incorporated. All Rights Reserved. Copyright 1995-2009 International Business Machines Corporation Copyright 2000-2006 The Legion Of The Bouncy Castle Copyright 2001 - 2010 The Apache Software Foundation Copyright 2002-2007 www.pdfbox.org Copyright 2006-2007 www.fontbox.org Copyright 2006-2007 www.
Used open-source software Apache XML Commons Apache XML Commons is a library containing common code for XML projects. Copyright 1998-2004 World Wide Web Consortium Copyright 1999 IBM Corporation, http://www.ibm.com Copyright 1999 Sun Microsystems, http://www.sun.com Copyright 2001-2003, 2006 The Apache Software Foundation Apache XMLBeans Apache XMLBeans is a Java-to-XML binding framework. Copyright 2005 BEA under the terms of the Apache Software License 2.
Ext.ux.TinyMCE Ext.ux.TinyMCE is an ExtJS form field containing TinyMCE v3. It is released under LGPL 2.1 or higher. Copyright 2008-2010 BYTE-force, www.byte-force.com Source code is available at http://www.kerio.com/ GPL GhostScript GPL GhostScript is a software for manipulating with PostScript and PDF files. It is released under GPL license version 2. Copyright Artifex Software, Inc. and contributors. All Rights Reserved. Source code is available at http://www.kerio.
Used open-source software Hibernate Hibernate is Relational Persistence for Java and .NET. It is distributed under LGPL license. Copyright 2006-2008 Red Hat Middleware LLC or third-party contributors Copyright 2008 Ovidiu Feodorov Hibernate Search Hibernate Search is a full text search engine for the persistence domain model. It is distributed under LGPL license. Copyright 2005 JBoss Inc. a přispěvatelé Copyright 2008 Red Hat Middleware LLC. Source code is available at http://www.kerio.
JSON json.jar is a Java library that converts data to/from JSON data interchange format. Copyright 2002, 2006, 2008 JSON.org libcurl Libcurl is a free and easy-to-use client-side URL transfer library. It supports the following protocols: FTP, FTPS, HTTP, HTTPS, GOPHER, TELNET, DICT, FILE and LDAP. Copyright 1996-2008, Daniel Stenberg. libjpeg Libjpeg is a library for handling the JPEG (JFIF) image format. This software is based in part on the work of the Independent JPEG Group.
Used open-source software OpenLDAP Freely distributable LDAP (Lightweight Directory Access Protocol) implementation. Copyright 1998-2007 The OpenLDAP Foundation Copyright 1999 Juan C. Gomez. All rights reserved. Copyright 2001 Computing Research Labs, New Mexico State University, Portions Copyright 1999, 2000 Novell, Inc, Portions. All Rights Reserved. Copyright 1999 PADL Software Pty, Ltd.
QtBrowserPlugin QtBrowserPlugin solution is a QT4 component useful for implementing plugins for web browser. It is released under LGPL 2.1. Copyright 2009 Nokia Corporation and/or its subsidiary(-ies) Source code is available at http://www.kerio.com/ QtSingleApplication (LGPL) QtSingleApplication is a QT4 component that provides support for applications which can be only started once per each user. It is released under LGPL 2.1.
Appendix A Legal Notices Microsoft , Windows , Windows NT , Windows Vista , Internet Explorer , Active Directory , Outlook , ActiveSync and Windows Mobile are registered trademarks of Microsoft Corporation. Apple , Mac OS , Tiger, Panther , Leopard and Snow Leopard are registered trademarks or trademarks of Apple Computer, Inc. Linux is registered trademark of Linus Torvalds.
