ImgArchive – Initial setup

This blog describes how to initially setup ImgArchive. Normally this only needs to be completed very infrequently. For example for your system changes and you need to re-allocate disks.

Overview

ImgArchive consists of to main parts: The Vault and User area. Both may need changes from the default installation.

The Vault

This is where the images are stored for save keeping. This consists a master store or repository and a derivative store or repository. The master is used to store unmodified images directly from the source of images, normally a camera. however, may come from other sources such as a scanner.

The derivative repository is used to store modified images derived from images contained in the master repository.

Both these repositories can have up to two local backups plus cloud backups.

Note: local disks can be network drives providing the local resource is reliable.

These repositories and backups need possibly a large amounts of disk space depending on the number of images to be stored. The default location for these repositories is the installation disk, this is normally disk C:. As a result, the default locations for these repositories may not the be the best location. In addition the backups will be best placed on a different disk from the repositories to allow for disk failure of one location.

This blog will explain how to change these locations in further sections.

User space

This is where you the user of the archive, browse and edit the images contained in the archive. The location of this space is normally a folder called ImgArchive under your user profile folder. For example:

c:\Users\myname\ImgArchive

These are split into three sections:

  • Workspace – space where you can edit images contained in the repositories.
  • Picture Space – space where you can browse the images in the repositories.
  • WWW Space – space where you can browse the images as a web site.

These sections each have there own folders, these are:

  • workspace
  • pictures
  • www

All of which by default are sub-folders under the main user space folder. However again, this User Space folder can use a large amount of disk space. How much, depends on how this spaces is used and the configuration options selected, plus of course, how many images and the size of those images. These default locations can also be changed.

Workspace

This is where images are checked-out for editing. This can be configured to check-out all images or only selected ones. This space is optional. However, it is needed if you need to edit any of the images in the archive.

Pictures

This space contains all the images that are in the archive this includes both images the can be viewed directly and those that are in RAW format that may not be viewed directly depending on the settings on your browser.

WWW

This space contains images that can be viewable by using a standard web browser. This means any RAW images must be replaced with a converted image that can be viewed using a standard web browser such as a JPG image.

The administrative tool (iaadmin.exe)

This is the tool to use to modify ImgArchive’s configuration. It is installed as part the ImgArchive package. If you have installed ImgArchive in administrator mode (which is the default and best option) then you will need to run the administration tool also in administrator mode. Do do this, find the terminal application in the start menu of applications then, instead of clicking on the terminal application, right click on it, this will open the right click menu. Hover on the More option and a second menu will open, then click on Run as administrator. A final popup will warn that this application can make changes to your device. click yes to this, as you do want to make changes to you device.

Type the following in a command prompt:

iaadmin about<cr>

If installed correctly, you will see the following (depending on release).

ImgArchive Administrator tool
iaadmin version "0.9.011" (build 64d7e1e9) Aug 12 2023 20:50:56
64 bit Windows  Copyright@(2017-2020) IDK Solutions Ltd.

This tool has a number of sub-commands all are documented in Administrative Housekeeping Reference.

The one used to change ImgArchive’s configuration is:

iaadmin config <option...>

Changing the Vaults configuration

This amounts to changing the two repositories configuration. Both have the same options.

Changing repositories location

Changing repositories location for both repositories This is achieved using the folder option.

iaadmin config --folders MasterPath=<path to master repository>

For the Master repository. And:

iaadmin config --folders DerivativePath=<path to master repository>

For the Derivative repository. If disk space allows, both repositories can be put on the same disk. For example:

iaadmin config --folders MasterPath=d:\imga\master

And:

iaadmin config --folders DerivativePath=d:\imga\derivative

Both these paths will share the imga folder on the d: drive.

Changing the Master and Derivative repository backups

In order to use the repositories backups you will need to give them a location on a disk and enable them. By default both backups are disabled for both the Master and Derivative repositories.

Both the Master and Derivative repositories use the same set of commands for controlling the backups and only the third option changes between specifying the Master or Derivative repositories.

iaadmin config --master <options..>
or
iaadmin config --derivative <options..>

Normally backups will be best placed on a different disk from the repositories to allow for disk failure of one location and if a second backup is used, this again would be best places on a different disk from the master repository and the first backup, thus allowing for three points of failure.

However, the repositories backups can be placed on the same disk for example backup one for the master and backup one for the derivative can be both placed on the same disk.

To enable backup one, backup two or both backups user the following:

iaadmin config –repository [BackupOneEnabled=<enable|disable>] | [BackupTwoEnabled=<enable|disable>]

for example:

iaadmin --master BackupOneEnabled=enable

This will enable the first backup (backup one) for the master to be enabled. Each of the backups can be enabled or disabled in the same way.

In order to use the backups a disk location for the backup needs to be specified to the configuration. The following commands:

iaadmin config –repository [BackupOne=<path to backup>] | [BackupTwo=<path to backup>]

For example:

iaadmin config --master BackupOne=e:\iaga\masterbackup1

This will set master backup one in the configuration to e:\iaga\masterbackup1 as the location for the backup. All the other backups can be configured in the same way.

Checking the configuration

To check the configuration, use the following commands:

iaadmin show --setting=master

This will have an output some thing like this:

Master Archive
==============
  Master Archive Location
        D:\Imga\master

  Master Archive Backups
        Backup One Enabled:        True
        Path Valid:                E:\imgaMasterBackup1
        Backup Two Enabled:        False
        Path not Valid:            C:\ProgramData\IDK-Software\ImgArchive/backup/MasterBackup2

Changing the User space configuration

The User space is divided into three optional parts: The workspace, picture space and the www space. Each of which can be enabled or disabled

Showing the User space options settings

To show the three areas that makeup the user space you will be using the:

iaadmim show setting <option> or iaadmim show setting=<option>

options again. This is just simply needs the

C:\Users\iferg>iaadmin show --setting workspace

Workspace
=========
  Workspace Location
        C:\Users\iferg\ImgArchive\Workspace
      Auto view: Off
  Auto checkout: Off

C:\Users\iferg>iaadmin show --setting=picture

Picture
=======
  Picture Location
        C:\Users\iferg\ImgArchive/Pictures
  Auto view: On

C:\Users\iferg>iaadmin show --setting=www

WWW
===
  path not found
  Auto view: Off