The tellusr.sh Script

The tellusr.sh is a wrapper for docker compose with some added functionality, like the install command that was used in Quick Install. It helps with adding necessary parameters to docker compose commands, like references to the configuration file and profile parameters.

You can execute commands with it by adding the command you want to run as a parameter: tellusr.sh <command>. It can also be run remotely with curl -s https://<DOWNLOAD_HOST>/tellusr.sh | bash -s <command>.

up

Start up TellusR, including containers with TellusR Central, TellusR NLP, and Solr with TellusR Integrator preinstalled. This wraps the docker compose up command.

down [central] [nlp] [solr] [zookeeper]

Take down all TellusR containers. This wraps the docker compose down command. This command will also remove the containers (not just stop them).

If you add the name of one or more services the command will affect only these. If not, it affects all.

stop [central] [nlp] [solr] [zookeeper]

Stop all TellusR containers. This will not remove them, which may be useful for investigating logs for example.

If you add the name of one or more services the command will affect only these. If not, it affects all.

restart [central] [nlp] [solr] [zookeeper]

Restart all TellusR containers. This will stop and start containers, removing them in between.

If you add the name of one or more services the command will affect only these. If not, it affects all.

install

Download all TellusR containers, install configuration and the tellusr.sh script, and start TellusR.

upgrade

Upgrade to the latest version of TellusR.

password

To set credentials for the API do tellusr.sh password <user>. You will be asked to set password for the given user. If you omit the use, i.e. tellusr.sh password then you will be asked to set password for the default tellusr user. These credentials are for contacting the tellusr API.

latest_version

Show the version of the latest version of TellusR that has been released.

version

Show the version of the currently installed TellusR.

uninstall

Uninstall current install of tellusr. You will be asked if you want to delete volumes, images and config as well.