Quick Demo Install

​Use the install script to install the latest version of scorch suite in your current directory with a demo job

wget && chmod a+x install && ./install


Normal Installation

ScOrch is designed to be used as a team collaboration tool. As such it should be installed under a common directory with group read and execute permissions and owned by a system account. It can also be installed by each user under their home directory if required, or can use private job directories or private plugin directories with a private or group scorch. The combinations offer a lot of flexibility.

The open source version, is a single script with the simplified functions embedded and reduced comments. The enterprise version is a tar file that contains scorch, license details and the functions directory with commented functions.

Bash version 4 minimum is assumed.

Select an installation directory and version


The following can then be used in a Unix or Linux docker shell or directly into any other bash shell (including Bash for Windows)

mkdir ${INSTALL_DIR}
curl -o ${INSTALL_DIR}/scorch.tar${VERSION}.tar
tar xf scorch.tar
./scorch -install

Obrar installation

`obrar` is now included with `scorch`

ScOrch Setup

Decide on a scorch base directory, system owner account and group account.

Have your friendly system administrators create the account, group and directory as well as assigning users to the group. In the example below user scorch, group scorch and directory /opt/scorch have been chosen.

A simple way to create the users is shown below and as the directory structure for scorch handles its own logs, the directory has been given its own file system. Your organisation my have other requirements or products to setup the accounts. There may be other considerations in your organisation. If in doubt consult your Linux Support team:

$ dir_Base=/opt/scorch # Example base directory
$ adduser -U -m -d ${dir_Base} scorch # scorch framework owner


There is a new group feature (available from 1.54) to overcome a requirement for all users to be in the same primary group. If you wish to use ScOrch for collaboration work, chose a group by un-commenting out the export str_Group line in the main scorch program

vi scorch

Then    /str_Group=     and un-comment for group directory and file creation export str_Group=scorch


Adding a new user to the group

If you wish to create new users use useradd. In this example we are adding the user bob: $ useradd -g scorch bob # User is a member of scorch only

Modifying a current user to be part of the group.

If you already have users you wish to make part of the group, use the usermod command. In this example we are adding user marc to the scorch group.

$ usermod -g scorch marc # Add scorch group to user

The above will create the base directory automatically, but this could also be made manually and need to be changed to allow the scorch group to access files.

$ chmod 750 ${dir_Base} # Allow group read/execute

Log in as the chosen system user, in this scenario the chosen system account is deploy. Extract the tar file into the chosen directory into this directory and execute it for the first time as the system user.

$ sudo -iu scorch
$ dir_Base=/opt/scorch
$ cd ${dir_Base}
$ wget
$ chmod u+x install
$ ./install


AC Version

# As root
groupadd deployr
adduser -m -d ${dir_Base} deploy -G deployr
id deploy

# uid=deploy gid=deploy groups=deploy,deployr
adduser -m deployr -g deployr

# As scorch owner
sudo su - deploy
cd ${dir_Base}
chmod 740 install
    # Enter y to set the deployr group
rm ./install

./scorch -install