Chapter 1. Installation

yaffas has to be installed on a freshly set up Linux distribution. At the moment Ubuntu 10.04/12.04, Debian 6/7 and Red Hat 5/6 are officially supported. The following steps describe how yaffas can be installed. There are packages available for both 32bit and 64bit architectures.

1.1. System requirements

  • Ubuntu Server 10.04/12.04, Debian 6/7 or Red Hat Enterprise Linux 5/6
  • Correctly configured fully qualified hostname
  • Static IP address

yaffas can be installed on a preconfigured Zarafa system, however, please be aware that your configuration will be overwritten and that you can loose your data!

Please also make sure that your MySQL password does not contain a hash sign (#) since there is a problem with the current configuration management.

1.2. Procedure

yaffas can be installed from the repositories described below for the two supported Linux distributions.

1.2.1. Installation on existing server

Right now the installation on an existing server is not recommended and not supported. Before considering to go this way, either wait for one of the next releases or install on a clean machine and migrate your data to the new system.

If you still wish to install it on an existing server make sure you have a backup or make a copy of your actual machine.

To install yaffas on such a system, install the packages as described below, but skip the installation wizard (change /opt/yaffas/etc/webmin/webmin.acl symlink to point to webmin.acl-global instead of -setup), as it would delete all your data.

You will have to do several configuration changes on your own. You can figure out the necessary details by inspecting the relevant resources (/opt/yaffas/share/yaffas-upgrade/, /opt/yaffas/share/yaffas-ldap/, and the source code of the packages as found on http://www.github.com/bitbone/yaffas/).

We invite you to ask for community support for this installation path, which we will monitor closely on the forum and possibly create a standardized procedure from this.

1.2.2. Ubuntu Server

Adding required repositories

Add the following repositories in order to install yaffas and required dependencies via the standard apt commands.

Ubuntu 10.04 LTS

echo "deb http://repo.yaffas.org/releases/latest/lucid ./" >> /etc/apt/sources.list

Ubuntu 12.04 LTS

echo "deb http://repo.yaffas.org/releases/latest/precise ./" >> /etc/apt/sources.list

Please also ensure that the universe repository is enabled (check via grep universe /etc/apt/sources.list).

[Note]

If you need a proxy to download from internet, just set the "http_proxy" variable

export http_proxy="http://<user>:<password>@<your-proxy>:<port>"
export HTTP_PROXY="$http_proxy"

You should later make this setting permanent by setting the proxy in the user interface (Network > Configuration > HTTP Proxy). This will also ensure that all supported services can properly use the proxy (such as ClamAV’s freshclam).

Import package key

wget -O - http://repo.yaffas.org/repo.deb.key | apt-key add -

Install the packages

apt-get update
apt-get install yaffas

This will install yaffas base modules and zarafa.

During the installation zarafa, mysql, openldap, postfix and many other dependencies are installed.

The package manager will usually ask questions for some packages. You can skip all of these by pressing "enter" when the dialog pops up. The configuration of these will be done by the yaffas installation procedure later.

Only if you are asked for a MySQL server root password you should enter a password and note it down as you will be asked for MySQL credentials when first using yaffas.

images/en/1_mysql_thumb.png images/en/2_mysql_repeat_thumb.png

Leave the LDAP configuration values without changes:

images/en/3_ldap_thumb.png images/en/4_ldap_thumb.png images/en/5_ldap_thumb.png images/en/6_ldap_thumb.png images/en/7_ldap_thumb.png images/en/8_ldap_thumb.png images/en/9_ldap_thumb.png

For postfix configuration select the "local only" type:

images/en/10_postfix_thumb.png images/en/11_postfix_thumb.png images/en/12_postfix_thumb.png

Use the default values for kerberos configuration:

images/en/13_kerberos_thumb.png images/en/14_kerberos_thumb.png images/en/15_kerberos_thumb.png

1.2.3. Debian 6 and 7

Adding required repositories

Just add our repository as described below in order to install yaffas and required dependencies via the standard apt commands.

For Debian 6:

echo "deb http://repo.yaffas.org/releases/latest/squeeze ./" >> /etc/apt/sources.list

For Debian 7:

echo "deb http://repo.yaffas.org/releases/latest/wheezy ./" >> /etc/apt/sources.list
[Note]

If you need a proxy to download from internet, just set the "http_proxy" variable

export http_proxy="http://<user>:<password>@<your-proxy>:<port>"
export HTTP_PROXY="$http_proxy"

You should later make this setting permanent by setting the proxy in the user interface (Network > Configuration > HTTP Proxy). This will also ensure that all supported services can properly use the proxy (such as ClamAV’s freshclam).

Import package key

wget -O - http://repo.yaffas.org/repo.deb.key | apt-key add -

Install the packages

apt-get update
apt-get install yaffas

This will install yaffas base modules and zarafa.

During the installation zarafa, mysql, openldap, postfix and many other dependencies are installed.

The package manager will usually ask questions for some packages. You can skip all of these by pressing "enter" when the dialog pops up. The configuration of these will be done later by the installation wizard.

Only if you are asked for a MySQL server root password you should enter a password and note it down as you will be asked for MySQL credentials when first using yaffas.

images/en/1_mysql_thumb.png images/en/2_mysql_repeat_thumb.png

Leave the LDAP configuration values without changes:

images/en/3_ldap_thumb.png images/en/4_ldap_thumb.png images/en/5_ldap_thumb.png images/en/6_ldap_thumb.png images/en/7_ldap_thumb.png images/en/8_ldap_thumb.png images/en/9_ldap_thumb.png

For postfix configuration select the "local only" type:

images/en/10_postfix_thumb.png images/en/11_postfix_thumb.png images/en/12_postfix_thumb.png

Use the default values for kerberos configuration:

images/en/13_kerberos_thumb.png images/en/14_kerberos_thumb.png images/en/15_kerberos_thumb.png

1.2.4. Red Hat Enterprise Linux

The installation on Red Hat Enterprise Linux is similar.

[Note]

If you need a proxy to download from internet, just set the "http_proxy" variable

export http_proxy="http://<user>:<password>@<your-proxy>:<port>"
export HTTP_PROXY="$http_proxy"

You should later make this setting permanent by setting the proxy in the user interface (Network > Configuration > HTTP Proxy). This will also ensure that all supported services can properly use the proxy (such as ClamAV’s freshclam).

Adding the required repositories

The yaffas packages will require some dependencies. As these dependencies are not part of the standard RHEL repository, the following two repositories have to be added to the installed system.

Repositories for RHEL 5

Run the following command to install the EPEL repository:

rpm -Uvh http://download.fedoraproject.org/pub/epel/5/i386/epel-release-5-4.noarch.rpm

If the above referenced URL is no longer functional because a newer version of the package is available, then you can still get the latest version from this address: http://download.fedoraproject.org/pub/epel/5/i386/repoview/epel-release.html

Then, depending on your architecture, run the following commands to add the RPMforge repository:

rpm -Uvh http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.i386.rpm

or

rpm -Uvh http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el5.rf.x86_64.rpm

Repositories for RHEL 6

Run the following command to install the EPEL repository:

rpm -Uvh http://download.fedoraproject.org/pub/epel/6/i386/epel-release-6-8.noarch.rpm

If the above referenced URL is no longer functional because a newer version of the package is available, then you can still get the latest version from this address: http://download.fedoraproject.org/pub/epel/6/i386/repoview/epel-release.html

Then, depending on your architecture, run the following commands to add the RPMforge repository:

rpm -Uvh http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.i686.rpm

or

rpm -Uvh http://packages.sw.be/rpmforge-release/rpmforge-release-0.5.2-2.el6.rf.x86_64.rpm
[Note]

For Red Hat Enterprise Linux systems it is necessary to subscribe to the "RHEL Server Optional" channel. This is not done by default.

yaffas repository

After the extra repositories are added, the yaffas repository has to added:

Create a file "yaffas.repo" in folder /etc/yum.repos.d with the following contents:

[yaffas]
name = yaffas $releasever
baseurl = http://repo.yaffas.org/releases/latest/rhel/$releasever
enabled = 1
protect = 0
gpgcheck = 1
priority = 1

Additionally, the EPEL configuration has be to changed due to a recent dependency problem. To do that, add the following line at the end of the [epel] block in /etc/yum.repos.d/epel.repo (after gpgkey=...):

exclude=clamav* clamd* amavisd*

Import GPG keys

rpm --import http://repo.yaffas.org/repo.rpm.key

Package installation

yum install yaffas
[Note]

If running the above command leads to a conflict between php-common and php53-common on RHEL5, then this is because of a packaging bug. You can work around this by running

yum remove php53 php53-common
yum install php php-ldap php-mapi php-pecl-json

before re-running

yum install yaffas

1.3. First steps

After installation, the yaffas web interface is accessible at the following URL: https://<your-server's-ip>:10000

The username is "admin" and password is "yaffas".

images/en/yaffas/16_login_thumb.png

On first login, the setup assistant will be launched.

images/en/yaffas/17_setup_thumb.png

[Warning]

The setup procedure will change the following settings and data will be deleted or overwritten:

  • existing LDAP tree
  • slapd configuration
  • Samba configuration
  • smbldap-tools configuration
  • postfix configuration
  • zarafa configuration
  • MySQL configuration (optimizations for Zarafa will be made)

The installer will ask you to change the default admin password.

images/en/yaffas/18_setup_basic_thumb.png

Next you will have to specify a MySQL server for Zarafa. The given user must have enough persmissions to access (or create) the given database.

images/en/yaffas/19_setup_zarafa_thumb.png

In the next step, the mail server parameters will be configured. A primary mail domain (e.g. machinename.example.org) has to be configured, a smart host (and the required authentification data) has only be specified, if the yaffas server should forward all outgoing mails to the given host.

images/en/yaffas/20_setup_mailserver_thumb.png

In the last step, you have the opportunity to enable local authentication and create a first user for your system.

images/en/yaffas/21_setup_createuser_thumb.png

If you decide not to create a local user now, an authentication server has to be configured after finishing the setup wizard.

On Red Hat Enterprise Linux you also need to start the required services and configure them for automatic start at boot. This is can be done in "System → Services". Since by default an iptables firewall is active in Red Hat Enterprise Linux, the ports for the needed services have to be opened manually.

The next step should be to configure the mail server. Without a working mail server configuration some parts of the system will not work. It will also not be possible to create resources for Zarafa when no local domain is set for the mail server.

Now you can go Accounts → User Management and create some users.

After this step you should be able to login to Zarafa WebAcess if you go to https://<your-server’s-ip>/webaccess or WebApp https://<your-server’s-ip>/webapp

[Important]

The language in the yaffas UI has to be set for the folders in Zarafa to be created in the right language. This should be done prior to the creation of users.

1.4. Additional Steps

Additional features like brick-level backups and the Multi-User-Calendar plugin for WebAccess can be enabled by manually installating the package zarafa-backup or zarafa-webaccess-muc respectiveley (using yum install on RHEL and apt-get install on Debian/Ubuntu). This will only work if you have a commercial Zarafa license.

1.5. Updating

Every networked system should regularly be updated with the latest security fixes. This is valid for your fresh yaffas system as well, of course. In addition, we regularly provide updated packages for both Zarafa and yaffas components so that you can get the latest bug fixes and improvements.

Therefore it is important for you to check for updates periodically.

On Debian/Ubuntu systems, please use apt-get update && apt-get upgrade and confirm.

[Important]

Always choose to keep any config files which apt may want to overwrite. Do not overwrite them. Doing so would probably break your installation! In other words, just press ENTER (which chooses the default answer of [N]o when you are asked.

On RHEL systems, please use yum upgrade and confirm. == Basic usage instructions

1.6. Opening the administration web interface

The yaffas administration interface is accessible through https:// using the previously configured ip address on port 10000. If you used the address 192.168.100.100, for instance, the complete address would look like this:

https://192.168.100.100:10000/

images/en/yaffas/22_overview_thumb.png

1.7. Usage

The main interface is split into the navigation area on the left side and the content area on the right. Use your mouse to select the category you wish to access in the navigation menu. A sub-menu with the available configuration modules will open. After clicking on one of these modules, the available sub-sections will appear on the right in the content area.

[Note]

Many functions which work on specific objects (such as the user administration) are available by using the context menu. The context menu can be opened by right-clicking on an entry in the relevant table.

More-specific descriptions can be found in the following chapters.