Child pages
  • Reference Pillar Installation Guide

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Excerpt

The ReferencePillar currently comes in two different formats, the FullReferencePillar and the ChecksumReferencePillar (also know as the ChecksumPillar), and currently they both requires commandline installation and instantiation.

This is the guide for installing ReferencePillars of version 0.19 or more.

Installation of the ReferencePillar

The installation of the ReferencePillar is done in the following way:

  1. Download the ReferencePillar zip file. (https://sbforge.org/nexus/content/repositories/releases/org/bitrepository/reference/bitrepository-reference-pillar/)
  2. Unzip the zip-file.
  3. Go to the directory root directory, where the zip-file has been unzipped (named 'bitrepository-reference-pillar-VERSION').
  4. Copy your settings files into the 'conf' subfolder, e.g. the CollectionSettings.xml and the ReferenceSettings.xml. (There is already placed examples of these settings in the 'conf' directory)
  5. Copy you certificate file (e.g. 'pillar-XX.pem') in the 'conf' subfolder.
  6. Run the bin/create_databases.sh script. This will create the checksum and auditContributor databases according to the settings in the ReferenceSettings.xml.

FullReferencePillar

To instantiate the FullReferencePillar run the script from the 'bin' folder:

Code Block
reference-pillar.sh start

And to stop it again:

Code Block
reference-pillar.sh stop

The pillar can be restarted with the command:

Code Block
reference-pillar.sh restart

The status for the pillar can be checked with the command (e.g. whether it is running):

Code Block
reference-pillar.sh status

 ChecksumPillar

The ChecksumPillar has the exact same functions as the FullReferencePillar, the script is just called 'checksum-pillar.sh' instead of 'reference-pillar.sh':

Code Block
checksum-pillar.sh start
checksum-pillar.sh stop
checksum-pillar.sh restart
checksum-pillar.sh status

Upgrading the ReferencePillar

Before you upgrade the ReferencePillar (either the FullReferencePillar or the ChecksumPillar) make sure, that you have the following (e.g. place a copy outside the current installation prior to upgrading):

  • The zip-file with the new version of the ReferencePillar.
  • The CollectionSettings, ReferenceSettings and certificate for the new installation of the ReferencePillar (they might be same as for the version you are about to upgrade)

Refer to the release-notes for the version you are about to upgrade to. Follow the version specific upgrade guides, if any.

To upgrade an existing ReferencePillar while preserving the databases and files do the following:

  • Shutdown the current instance of the pillar (e.g. run 'reference-pillar.sh stop' or 'checksum-pillar.sh stop' in the 'bin' folder).
  • Delete the 'bin', 'lib' and 'conf' folders in the installation directory of the pillar.
  • Unzip the file into the current installation directory (or unzip it elsewhere and move the folders 'bin', 'conf' and 'lib' into the installation directory of the pillar).
  • Copy the CollectionSettings, the ReferenceSettings and the certificate files for the ReferencePillar into the 'conf' directory.
  • Start the pillar (e.g. run 'reference-pillar.sh start' or 'checksum-pillar.sh start').