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://dist.tellusr.com/tellusr.sh | bash -s install
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
tellusr.config file must comply with .env format of
docker compose: https://docs.docker.com/compose/environment-variables/#the-env-file
tellusr.config will look something like this:
# TELLUSR_RESTART_POLICY=always # no
# Added version 4.0-RC1 at Mon, 29 Jan 2024 16:52:07 +0000 by
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
You can start TellusR and create your first core using this with:
bin/tellusr.sh create <projectname>
Please replace with the name of your project. This will start the tellusr services, and install a core (or a collection if using cloud mode) (found in
$HOME/tellusr/configset) to Solr.
You may, for convenience, add the
tellusr.sh script to the PATH by adding the following snippet to
When the installation is complete the TellusR Dashboard will be available on port 8989. If you are on the same machine you can access it at:
The endpoint documentation for the TellusR API will be available on port 8901.
You may expose them to port 8900 with
$HOME/tellusr/bin/tellusr.sh proxy up. This will set up authentication with username
tellusr and password
See the API section on how to import data.