Install Bootstrapping

Table of Contents Get a Taranis distribution package Bootstrap options Questions during installation Upgrading Upgrading from 3.3.x to 3.4.x Upgrading after 3.4.0 Reinstall a release Installing via GIT Use GIT to upgrade a distributed version

Get a Taranis distribution package

Since release 3.4.0, Taranis will install under a username, by default taranis. You may already have an older version of Taranis installed: 3.4 will try to attempt to convert your configuration.

On a freshly installed host, you need to start with a Taranis distribution package. A Taranis distribution package is named as taranis-$version.tar.gz. (Fill in your $version) Go to the Wiki Home to find the latest release.

If you have not received the bootstrap script separately, you can extract it from the Taranis package itself:

root# tar xzf taranis-$version.tar.gz taranis-$version/taranis-bootstrap
root# mv taranis-$version/taranis-bootstrap .

With any recent bootstrap script, you run:

root# ./taranis-bootstrap taranis-$version.tar.gz

The bootstrap script will start with creating the user ‘taranis’ (if the name doesn’t already exist). It will unpack the sources (if not unpacked already) into ~taranis/sources/taranis-$version. Then it starts the install scripts which are contained in the package.

Bootstrap options

The more popular options of the taranis-bootstrap commands are:

-u --user USERNAME   (default 'taranis')
-g --group GROUPNAME (default 'taranis')
-m --migrate DIR     (default '/opt/taranis')

Install the software under this username. You can safely run very distinct releases of Taranis under different usernames on the same server.

Questions during installation

During installation, you will get some questions. These values will get stored in ~taranis/etc/setup-generic or ~taranis/etc/setup-$version may change them later, by hand in that file, but need to rerun taranis install to effectuate them.

Also, you may get some questions from the Perl modules during the installation. You can simply accept the defaults.

Have a look at Solving Issues when you encounter problems.

Upgrading

Upgrading from 3.3.x to 3.4.x

Please, read the release notes for 3.4.0. You do not need to install intermediate releases: you can upgrade directly from any 3.3 version to any 3.4 version.

Upgrading after 3.4.0

When you wish to upgrade to a newer release, you have the following options:

1. Bootstrap with a new username: read the taranis bootstrap procedure.
2. Share an installation under an existing username: become that user and run taranis install taranis-$new_version.tar.gz
3. Install from GIT under the existing username

In both the second and third case, you must be careful which database you assign to the instances: you cannot share the database between 3.3 and 3.4 releases, but 3.4.0 and 3.4.1 can share one without too many problems. Read the release notes to be sure.

When you create a new username to install a parallel instance (or same username on a different server), you need the content of ~/var, ~/local*, and the database from your older installation.

Reinstall a release

When working via GIT you may want to reinstall from source. This may also happen when you have manually messed-up the installed sources f.i. for debugging. You can rerun installation as often as you want: it should only make minimal changes to your configuration to make it work again.

Once you have bootstrapped a Taranis user, you may want to skip the check for missing Perl modules or Linux packages. Newer versions have other bugs, and the check is relatively slow. Skip these checks via:

tara$  taranis install --no-internet       # Skip external  checks

Installing via GIT

(requires 3.4.1-rc3) Taranis release branches are available through public GitHub. You will first need to install Taranis via a packages, as described about. Then run this:

tara$  taranis git init
tara$  cd sources/taranis-git
tara$  git checkout $any_branch
tara$  taranis install      # code stays in GIT
tara$  taranis restart      # daemon needs to run new code

When you make changes to

• the templates or in the 'scripts' directory, they will be visible in the installed site immediately.
• changes in javascript, css, or images, require a shift-reload in your browser.
• changes in the pm directory are only effective when you reload the server with `taranis restart'

Use GIT to upgrade a distributed version

Once you have GIT configured, you can also upgrade an installed version. In this case, the used files will get copied into `~taranis/taranis-$version`. To achieve this, run (in any directory)

tara$  taranis install --version 3.4.1-rc2 # Explicit version
tara$  taranis install --version 3.4       # Newest version in 3.4

or

tara$  cd ~/sources/taranis-3.4.1
tara$  taranis install --git               # Reinstall 3.4.1 from GIT