We recommend the following minimum specification for a system hosting TellusR: 8 cores, 24 GB RAM, and 300 GB Disk. The preferred server OS is Ubuntu 22.04.4 LTS.
When using tellusr you should have the latest version of docker compose installed, as the yaml specification is changing rapidly:
If you are installing on an ubuntu server you may install the docker engine and docker compose by following these instructions instead:
sudo adduser tellusr
sudo usermod -aG docker tellusr
sudo su - tellusr
curl -s https://<DOWNLOAD_HOST>/tellusr.sh | bash -s install
(Please contact TellusR for the download host.)
This will download TellusR components from the docker hub. A configuration file named tellusr.config and a docker-compose.yml file is added to the directory $HOME/tellusr. The tellusr.config file must comply with .env format of docker compose: https://docs.docker.com/compose/environment-variables/#the-env-file
The tellusr.config will look something like this:
# Modify this file to set environment variables for the compose files
# that deploy tellusr.
GATHER_SEARCH_STATS=true
IMPORTER_MAX_WORKERS=1
NLP_SERVICE_RAM=8g
NLP_SERVICE_CPUS=2
NLP_SERVICE_GPUS=0
# TELLUSR_RESTART_POLICY=always # no
SOLR_HEAP=4g
FLOW_COMPOSE_FILE=flow-compose-single-solr.yml
TELLUSR_PROFILE=default
Entries beginning with # is commented out, and you need to uncomment them if you want to override the defaults.
If you are running TellusR on your local machine TELLUSR_RESTART_POLICY=no will ensure that it does not restart automatically when you reboot.
During installation the tellusr.sh script is put int the $HOME/tellusr/bin directory.
To start TellusR and create your first project use the following commands:
Navigate to the tellusr directory:
cd $HOME/tellusr
To start tellusr do:
bin/tellusr.sh up
When you have done this you should set up passwords for the general user and the admin user (the difference between the two users is described in the Access section). You can do this by running two tellusr.sh commands:
bin/tellusr.sh admin_password
Will change the password of the admin user. To do the same for the tellusr user you can do:
bin/tellusr.sh password
You may, for convenience, add the tellusr.sh script to the PATH by adding the following snippet to $HOME/.bashrc.
export PATH=$PATH:$HOME/tellusr/bin
When the installation is complete the TellusR Dashboard will be available on port 8900. If you are on the same machine you can access it at:
The interactive openapi documentation for the TellusR API will be available on:
You may expose them to port 80 with $HOME/tellusr/bin/tellusr.sh proxy up. This will set up authentication with username tellusr and password TellusRSwings.
See the importing data section on how to import data to TellusR.