Installing Tarantool software

$ tt install PROGRAM_NAME [VERSION|COMMIT_HASH|PR_ID] [OPTION ...]

tt install installs the latest or an explicitly specified version of Tarantool or tt. The possible values of PROGRAM_NAME are:

tarantool: Install Tarantool Community Edition.
tarantool-dev: Install Tarantool from a local build directory.
tarantool-ee: Install Tarantool Enterprise Edition.
tt: Install the tt command-line utility.

Примечание

For tarantool-ee, account credentials are required. Specify them in a file (see the ee section of the configuration file) or provide them interactively.

Additionally, tt install can build open source programs tarantool and tt from a specific commit or a pull request on their GitHub repositories.

To uninstall a Tarantool or tt version, use tt uninstall.

Options

--dynamic¶

Applicable to: tarantool, tarantool-ee

Use dynamic linking for building Tarantool.

-f, --force¶: Skip dependency check before installation.

--local-repo¶: Install a program from the local repository, which is specified in the repo section of the tt configuration file.

--no-clean¶: Don’t delete temporary files.

--reinstall¶: Reinstall a previously installed program.

--use-docker¶

Applicable to: tarantool, tarantool-ee

Build Tarantool in an Ubuntu 18.04 Docker container.

Details

When called without an explicitly specified version, tt install installs the latest available version. To check versions available for installation, use tt search.

By default, available versions of Tarantool Community Edition and tt are taken from their git repositories. Their installation includes building from sources, which requires some tools and dependencies, such as a C compiler. Make sure they are available in the system.

Tarantool Enterprise Edition is installed from prebuilt packages.

Authentication

To install Tarantool EE using tt install, you need to provide access credentials for the Tarantool customer zone. Use one of the following ways to pass the username and the password:

A text file specified in the ee.credential_path parameter of the tt enviromnment configuration:
```
# tt.yaml
# ...
ee:
  credential_path: cred.txt
```
cred.txt should contain a username and a password on separate lines:
```
myuser@tarantool.io
p4$$w0rD
```

Environment variables TT_CLI_EE_USERNAME and TT_CLI_EE_PASSWORD:

$ export TT_CLI_EE_USERNAME=myuser@tarantool.io
$ export TT_CLI_EE_PASSWORD=p4$$w0rD
$ tt install tarantool-ee

Development versions

tt install can be used to build custom Tarantool and tt versions for development purposes from commits and pull requests on their GitHub repositories.

To build Tarantool or tt from a specific commit on their GitHub repository, pass the commit hash (7 or more characters) after the program name. If you want to use a PR as a source, provide a pr/<PR_ID> argument:

$ tt install tarantool 03c184d
$ tt install tt pr/50

If you build Tarantool from sources, you can install local builds to the current tt environment by running tt install with the tarantool-dev program name and the path to the build:

$ tt install tarantool-dev ~/src/tarantool/build

Local repositories

You can also set up a local repository with installation files you need. To use it, specify its location in the repo section of the tt configuration file and run tt install with the --local-repo flag.

Example

Install the latest available version of Tarantool CE:
```
$ tt install tarantool
```
Install Tarantool 2.11.1 from the local repository:
```
$ tt install tarantool 2.11.1 --local-repo
```

Reinstall Tarantool 2.10.8:

$ tt install tarantool 2.10.8 --reinstall

Install Tarantool from a PR #1234 on the tarantool/tarantool GitHub repository:
```
$ tt install tarantool pr/1234
```
Install tt from a commit with a hash 40e696e on the tarantool/tt GitHub repository:
```
$ tt install tt 40e696e
```

Install Tarantool built from sources:

$ tt install tarantool-dev ~/src/tarantool/build

Версия:

Installing Tarantool software

Options

Details

Authentication

Development versions

Local repositories

Example