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:
NLP_LANGUAGES=en,no
# NLP_SERVICE_SHM_SIZE="3gb"
NLP_SERVICE_WORKERS=2
NLP_SERVICE_CPUS_PER_WORKER=2
NLP_SERVICE_GPUS_PER_WORKER=0
NLP_SERVICE_RAM=24g
NLP_SERVICE_TOTAL_CPUS=4
# TELLUSR_RESTART_POLICY=always # no
# TELLUSR_SOLR_URL="http://solr:8983/solr"
SOLR_HEAP=16g
TELLUSR_PROFILE=flow
# TELLUSR_SETUP_CONFIGSET="$HOME/tellusr/configset"
# Added version 4.0-RC1 at Mon, 29 Jan 2024 16:52:07 +0000 by
NLP_SERVICE_VERSION_TAG=4.0-RC1
CENTRAL_VERSION_TAG=4.0-RC1
SOLR_VERSION_TAG=4.0-RC1
FLOW_CONTROL_VERSION_TAG=4.0-RC1
API_VERSION_TAG=4.0-RC1
UPDATE_ASSISTANT_VERSION_TAG=4.0-RC1
API_VERSION_TAG=4.0-RC1
PROXY_VERSION_TAG=4.0-RC1
Entries beginning with # is commented out, and you need to uncomment them if you want to override the defaults.
If you only need semantic search in Norwegian it is a good idea to define NLP_LANGUAGES=no, as the English dictionary requires a lot of resources.
If you are running TellusR on your local machine TELLUSR_RESTART_POLICY=no will ensure that it does not restart automatically when you reboot.
If you want to connect to a Solr instance that is not controlled by this setup you could do so by defining TELLUSR_PROFILE=external_solr and making TELLUSR_SOLR_URL point to the Solr instance you want to use.
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
To create a project with the name do:
bin/tellusr.sh create <project>
Please replace with the name of your project.
This will create a solr collection with the same name as the project (found in $HOME/tellusr/configset) to Solr.
A tellusr project acts as an ID for a collection of indexed documents, and the documents in two different project are disjoint.
The documents you upload to TellusR can be organized in one or more “projects”.
Each project can have its own configuration settings governing indexing, storage, and search behaviour.
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 API section on how to import data.