Installing Krang

This document describes how to install Krang on your system.

Supported Platforms

Krang supports the following operating system platforms:

Krang will likely compile fine on other similar platforms, but you'll need to download the source distribution and build it yourself. See Building Krang from Source.

Software Requirements

Before you can install Krang you'll need Perl version 5.6.1 or later and MySQL version 4.0.13 or later. You can download Perl here:

  http://www.perl.com/download.csp

And MySQL 4 can be found here:

  http://www.mysql.com/downloads/mysql-4.0.html

Krang may require additional software, depending on your operating system. Be sure to read the platform-specific README (eg. README.Redhat9) included with Krang.

Choosing a Distribution

When you download Krang you must choose a distribution that matches your operating system and version of Perl. If you don't know what version of Perl you have, run this command on your command-line:

  perl -MConfig -e 'printf "perl%d.%d.%d-%s",
                    (map { ord($_) } split("", $^V, 3)), $Config{archname}'

This will print something like:

  perl5.6.1-i686-linux

Using this information, if you wanted to install Krang 1.013 on Redhat 7.3 you would download:

  krang-1.013-Redhat7_3-perl5.6.1-i686-linux.tar.gz

Krang also has a special source distribution with -src instead of a platform description (ex: krang-1.013-src.tar.gz). You can download this release and attempt to build Krang from source. Of course, this may require porting work if Krang doesn't support your platform.

Building Krang from Source

If you downloaded the source distribution (ex: krang-1.013-src.tar.gz) then you'll need to build Krang before you can install it. If you've got a binary distribution, skip ahead to Installation.

First, untar the source tar-ball and enter the directory:

  tar zxvf krang-1.013-src.tar.gz
  cd krang-1.013-src

If there's a README file for your platform (ex: README.FreeBSD5), read that now. It will tell you about software you'll need to install before building Krang.

Now try building Krang using the bin/krang_build script:

  bin/krang_build

To build a version of krang that supports SSL, then supply the with-ssl option.

  bin/krang_build --with-ssl

If Krang complains that it doesn't know what platform to build for you can pass it a platform name:

  bin/krang_build Redhat9

If that works, you can now build a binary distribution for your platform and proceed to the next step:

  bin/krang_makedist

If not, you'll have to do some porting work to get Krang working on your system. To learn more about porting Krang, read this:

  http://krang.sourceforge.net/docs/porting.html

Installation

Once you've downloaded a Krang binary distribution, or built one from source, un-tar it and enter the directory created:

  tar zxvf krang-1.013-Redhat7_3-perl5.6.1-i686-linux.tar.gz
  cd krang-1.013-Redhat7_3-perl5.6.1-i686-linux

To install, run bin/krang_install as root, providing options describing how to setup Krang:

  # ./bin/krang_install \
         --HostName             $HostName            \
         --IPAddress            $IPAddress           \
         --AdminPassword        $AdminPassword       \
         --DBUser               $DBUser              \
         --DBPass               $DBPass              \
         --InstanceDBName       $InstanceDBName      \
         --InstanceHostName     $InstanceHostName    \
         --InstanceElementSet   $InstanceElementSet

These options are described below.

Localization

After installing Krang, you may optionally install localization distributions. To install the localization distribution for German, download Krang-Localization-Deutsch-VERSION.tar.gz and install it using lang/bin/krang_lang_installer:

  lang/bin/krang_lang_installer Krang-Localization-Deutsch-VERSION.tar.gz

Note that the VERSION number must be the same as the Version of Krang itself.

Required Variables

Before you install you must gather the following information. The following variables should be replaced in example shell commands with the appropriate values.

Optional Variables

Other variables may be required, depending on your installation needs:

Some definitions