Installation

 

Deploy on a dedicated server

Install Annotation Lab on a dedicated server to reduce the likelihood of conflicts or unexpected behavior.

Fresh install

To install Annotation Lab run the following command:

wget https://setup.johnsnowlabs.com/annotationlab/install.sh -O - | sudo bash -s VERSION

For installing the latest available version of the Annotation Lab use:

wget https://setup.johnsnowlabs.com/annotationlab/install.sh -O - | sudo bash -s --

To upgrade your Annotation Lab installation to a newer version, run the following command on a terminal:

Upgrade

wget https://setup.johnsnowlabs.com/annotationlab/upgrade.sh -O - | sudo bash -s VERSION

Replace VERSION within the above one liners with the version you want to install.

For upgrading to the latest version of the Annotation Lab, use:

wget https://setup.johnsnowlabs.com/annotationlab/upgrade.sh -O - | sudo bash -s --

After running the install/upgrade script the Annotation Lab is available at http://INSTANCE_IP or https://INSTANCE_IP

The install/upgrade script displays the login credentials for the admin user on the terminal.

Deploy on the AWS Marketplace

Visit the product page on AWS Marketplace and follow the instructions on the video below to subscribe and deploy.

Deploy Annotation Lab via AWS Marketplace

Deploy on AirGap environment

Get artifact

wget https://s3.amazonaws.com/auxdata.johnsnowlabs.com/annotationlab/annotationlab-VERSION.tar.gz

replace VERSION with the version you want to download and install.

Fresh installation

$ sudo su
$ ./annotationlab-installer.sh

Upgrade version

$ sudo su
$ ./annotationlab-updater.sh

Work over proxy

  • Custom CA certificate

You can provide a custom CA certificate chain to be included into the deployment. To do it add --set-file custom_cacert=./cachain.pem options to helm install/upgrade command inside annotationlab-installer.sh and annotationlab-updater.sh files. cachain.pem must include a certificate in the following format:

-----BEGIN CERTIFICATE-----
....
-----END CERTIFICATE-----
  • Proxy env variables

You can provide a proxy to use for external communications. To do that add

`--set proxy.http=[protocol://]<host>[:port]`, 
`--set proxy.https=[protocol://]<host>[:port]`, 
`--set proxy.no=<comma-separated list of hosts/domains>`

commands inside annotationlab-installer.sh and annotationlab-updater.sh files.

Backup and restore

Backup

You can enable daily backups by adding several variables with –set option to helm command in annotationlab-updater.sh:

backup.enable=true
backup.files=true
backup.s3_access_key="<ACCESS_KEY>"
backup.s3_secret_key="<SECRET_KEY>"
backup.s3_bucket_fullpath="<FULL_PATH>"

<ACCESS_KEY> - your access key for AWS S3 access <SECRET_KEY> - your secret key for AWS S3 access <FULL_PATH> - full path to your backup in s3 bucket (f.e. s3://example.com/path/to/my/backup/dir)

Notice: Files backups enabled by default. If you don’t need to backup files, you have to change

backup.files=true

to

backup.files=false

Configure Backup from the UI

Backup can also be configured by admin user from the UI. Goto Settings > Backup and set the parameters.

Restore

Database

To restore annotationlab from backup you need new clear installation of annotationlab. Do it with ‘annotationlab-install.sh’. Now, download latest backup from your s3 bucket and move and archive to restore/database/ directory. Next go to the restore/database/ directory and execute script ‘restore_all_databases.sh’ with name of your backup archive as argument.

For example:

cd restore/database/
sudo ./restore_all_databases.sh 2022-04-14-annotationlab-all-databases.tar.xz

Notice: You need xz and bash installed to execute this script. Notice: This script works only with backups created by annotationlab backup system. Notice: Run this scripts with sudo command

After database restore complete you can check logs in restore_log directory created by restore script.

Files

Download your files backup and move it to restore/files directory. Go to restore/files directory and execute script ‘restore_files.sh’ with name of your backup archive as argument. For example:

cd restore/files/
sudo ./restore_files.sh 2022-04-14-annotationlab-files.tar

Notice: You need bash installed to execute this script.

Notice: This script works only with backups created by annotationlab backup system.

Notice: Run this scripts with sudo command

Reboot

After restoring database and files, reboot AnnotationLab:

sudo reboot

System requirements. You can install Annotation Lab on a Ubuntu 20+ machine.

Port requirements. Annotation Lab expects ports 443 and 80 to be open by default.

Server requirements. The minimal required configuration is 32GB RAM, 8 Core CPU, 512 SSD. The ideal configuration in case model training and preannotations are required on a large number of tasks is 64 GiB, 16 Core CPU, 2TB HDD, 512 SSD.

Web browser support. Annotation Lab is tested with the latest version of Google Chrome and is expected to work in the latest versions of:

• Google Chrome

• Apple Safari

• Mozilla Firefox

Last updated