How to get Tezos¶
In this how-to we explain how to get up-to-date binaries to run Tezos (more precisely, the “Octez” implementation of Tezos software) on any network (either on the mainnet or on one of the test networks). Octez consists of several binaries (i.e., executable files), including: a client, a node, and a baker.
There are several options for getting the binaries, depending on how you plan to use Octez:
getting static binaries. This is the easiest way to get native binaries for the latest stable release, requiring no dependencies, under Linux.
installing binaries. This is the easiest way to install native binaries for the latest stable release, together with their dependencies, using a package manager.
using docker images. This is the easiest way to run the latest stable release of the binaries in Docker containers, on any OS supported by Docker.
building the binaries via the OPAM source package manager. Take this way to install the latest stable release in your native OS environment, automatically built from sources.
setting up a complete development environment by compiling the sources like developers do. This is the way to take if you plan to contribute to the source code. It allows to install any version you want (typically, the current development version on the master branch) by compiling it yourself from the sources.
These different options are described in the following sections.
Note that some of the packaged distributions are not only available for the latest stable release. For instance, static binaries are also available for release candidates, and Docker images are also available for the current development version (see Release System for more information).
When choosing between the installation options, you may take into account the convenience of the installation step (and of upgrading steps), but also efficiency and security considerations. For instance, static binaries have a different memory footprint compared to dynamically-linked binaries. Also, compiling the sources in the official Octez repository is more secure than installing OPAM packages from a repository that is not under Tezos control. In particular, compiling from sources enforces a fixed set of dependencies; when compiling via OPAM, this set of dependencies may change, which may or may not be compatible with your security practices.
All our installation scenarios are tested daily, including by automated means, to ensure that they are correct and up to date. These tests are performed by applying scenarios in several standard environments, from scratch. However, if you encounter problems when performing one of the installation scenarios in your own environment, you may want to take a look at Installation troubleshooting.
Getting static binaries¶
You can get static Linux binaries from the latest release in the tezos-packaging repository.
This repository provides static binaries for x86_64 and arm64 architectures. Since these binaries are static, they can be used on any Linux distribution without any additional prerequisites. However, note that, by embedding all dependencies, static binary executables are typically much larger than dynamically-linked executables.
For upgrading to a newer release, you just have to download and run the new versions of the binaries.
Installing binaries¶
Depending on your operating system, you may install Octez (dynamically-linked) binaries and their dependencies using a package manager, as follows.
Ubuntu Launchpad PPA with Octez packages¶
If you’re using Ubuntu, you can install packages with Octez binaries from a Launchpad PPA. Currently it supports Focal and Bionic versions.
In order to add the stable release PPA repository to your machine, do:
REPO="ppa:serokell/tezos"
Alternatively, to add the release candidates PPA instead, do:
REPO="ppa:serokell/tezos-rc"
Then, to install the binaries, run the following commands:
sudo add-apt-repository -y $REPO && sudo apt-get update
sudo apt-get install -y tezos-client
sudo apt-get install -y tezos-node
sudo apt-get install -y tezos-baker-ptnairob
sudo apt-get install -y tezos-accuser-ptnairob
Upgrading to a newer release is made easy by the APT package manager, using
commands such as apt-get update
, apt-get upgrade <package>
, and
apt-get install <new-package>
. Indeed, as the names of some packages (e.g.
the baker) depend on their version, you may have to also install new packages.
You may take a look at the available packages in the Octez PPA repository listed
by apt-get update
.
Fedora Copr repository with Octez packages¶
If you’re using Fedora, you can install packages with Octez binaries from a Copr repository. Currently it supports Fedora 35.
In order to add the stable Copr repository to your machine, do:
REPO="@Serokell/Tezos"
Alternatively, to add the release candidates Copr repository instead, do:
REPO="@Serokell/Tezos-rc"
Then, to install the binaries, run the following commands:
dnf copr enable -y $REPO && dnf update -y
dnf install -y tezos-client
dnf install -y tezos-node
dnf install -y tezos-baker-PtNairob
dnf install -y tezos-accuser-PtNairob
Upgrading to a newer release is made easy by the DNF package manager, using
commands such as dnf upgrade <package>
, and
dnf install <new-package>
. Indeed, as the names of some packages (e.g.
the baker) depend on their version, you may have to also install new packages.
You may take a look at the available packages in the Octez Copr repository
listed by dnf repoinfo
.
Using Docker Images And Docker-Compose¶
For every change committed in the GitLab repository, Docker images are
automatically generated and published on DockerHub. This provides a convenient
way to run an always up-to-date octez-node
.
One way to run those Docker images is with docker-compose.
We provide docker-compose
files for all active
protocols. You can pick one and start with the following command (we’ll assume alpha on this guide):
cd scripts/docker
export LIQUIDITY_BAKING_VOTE=pass # You can choose between 'on', 'pass' or 'off'.
docker-compose -f alpha.yml up
The above command will launch a node, a client, a baker, and an accuser for the Alpha protocol.
You can open a new shell session and run docker ps
in it, to display all the available containers, e.g.:
8f3638fae48c docker.io/tezos/tezos:latest octez-node 3 minutes ago Up 3 minutes ago 0.0.0.0:8732->8732/tcp, 0.0.0.0:9732->9732/tcp node-alpha
8ba4d6077e2d docker.io/tezos/tezos:latest octez-baker --liq... 3 minutes ago Up 31 seconds ago baker-alpha
3ee7fcbc2158 docker.io/tezos/tezos:latest octez-accuser 3 minutes ago Up 35 seconds ago accuser-alpha
The node’s RPC interface will be available on localhost and can be queried with octez-client
.
docker exec node-alpha octez-client rpc list
Building Docker Images Locally¶
The docker image used throughout the docker-compose files is fetched from upstream, but you can also build one locally and reference it. Run the following command to build the image:
./scripts/create_docker_image.sh
And then update the docker-compose file (e.g., alpha.yml
) with the docker tag:
node:
image: tezos:latest
...
Docker Image Configuration¶
Lastly, the entrypoint script (scripts/docker/entrypoint.sh) provides the following configurable environment variables:
DATA_DIR
: The directory to store the node’s data (defaults to/var/run/tezos
).NODE_HOST
: The name of the node container (defaults tonode
).NODE_RPC_PORT
: The RPC port inside the container the node listens to (defaults to8732
).NODE_RPC_ADDR
: The RPC address inside the container the node binds to (defaults to[::]
).PROTOCOL
: The protocol used.
These variables can be set in the docker-compose file, as demonstrated in alpha.yml
:
node:
...
environment:
PROTOCOL: alpha
...
If the above options are not enough, you can always replace the default entrypoint
and command
fields.
version: "3"
services:
node:
container_name: node-alpha
entrypoint: /bin/sh
command: /etc/my-init-script.sh
volumes:
- ./my-init-script.sh:/etc/my-init-script.sh
- ...
environment:
PROTOCOL: alpha
...
Building from sources via OPAM¶
The easiest way to build the binaries from the source code is to use the OPAM source package manager for OCaml.
This is easier than setting up a complete development environment, like developers do. However, this method is recommended for expert users as it requires basic knowledge of the OPAM package manager and the OCaml packages workflow. In particular, upgrading Octez from release to release might require tinkering with different options of the OPAM package manager to adjust the local environment for the new dependencies.
Environment¶
Currently Octez is being developed for Linux x86_64, mostly for Debian/Ubuntu and Arch Linux. The following OSes are also reported to work: macOS (x86_64), Arch Linux ARM (aarch64), Debian Linux (bullseye), Ubuntu Linux (focal). A Windows port is feasible and might be developed in the future.
Note
If you build the binaries by using the following instructions inside a
Docker container, you have to give extended privileges to this container,
by passing option --privileged
to the docker run
command.
Install OPAM¶
First, you need to install the OPAM package manager, at least version 2.0, that you can get by following the install instructions.
After the first install of OPAM, use opam init --bare
to set it up
while avoiding to compile an OCaml compiler now, as this will be done in
the next step.
Install Octez OPAM packages¶
The latest Octez release is available (as soon as possible after the release) directly as OPAM packages.
Note
Every file related to OPAM is (by default) in $HOME/.opam
which
means that, first, OPAM installs are user-specific and, second, you
can get rid of everything by removing this directory (+ updating
your rc files ($HOME/.bashrc
, $HOME/.profile
,
$HOME/.zshrc
, $HOME/.emacs
, …) if you asked/allowed OPAM
to add some lines in them).
The binaries need a specific version of the OCaml compiler (see the value
of variable $ocaml_version
in file scripts/version.sh
). To get an environment with it do:
wget -O latest-release:version.sh https://gitlab.com/tezos/tezos/raw/latest-release/scripts/version.sh
source latest-release:version.sh
opam switch create for_tezos $ocaml_version
eval $(opam env)
Note
The opam switch create
command may fail if the switch already exists;
you are probably re-installing or upgrading an existing installation.
If the required compiler version has not changed since the last time, you
may simply ignore this error. Otherwise, you are upgrading to a new compiler,
so look at the relevant section below.
The command eval $(opam env)
sets up required environment
variables. OPAM will suggest to add it in your rc file. If, at any
point, you get an error like octez-something: command not
found
, first thing to try is to (re)run eval $(opam
env --switch $ocaml_version)
(replace $ocaml_version
with its value
in scripts/version.sh
) to see if it fixes the problem.
In order to get the system dependencies of the binaries, do:
# depext handling is done directly by opam 2.1 and later
opam depext octez
Note
If an OPAM commands times out, you may allocate it more time for its
computation by setting the OPAMSOLVERTIMEOUT environment variable (to a
number of seconds), e.g. by adding OPAMSOLVERTIMEOUT=1200
before the
command. If no timeout occurs, you may omit this part.
Now, install all the binaries by:
opam install octez
You can be more specific and only opam install octez-node
, opam
install octez-baker-alpha
, … In that case, it is enough to install
the system dependencies of this package only by running opam depext
octez-node
for example instead of opam depext tezos
.
Warning
Note that opam install octez-client
and opam install
octez-signer
are “minimal” and do not install the support for
Ledger Nano devices. To enable it, run opam install
ledgerwallet-tezos
in addition to installing the binaries. (The
macro meta-package tezos
installs ledgerwallet-tezos
.)
Updating via OPAM¶
Installation via OPAM is especially convenient for updating to newer versions. Once some libraries/binaries are installed and new versions released, you can update by:
opam update
opam depext
opam upgrade
It is recommended to also run the command opam remove -a
in order
to remove the dependencies installed automatically and not needed
anymore. Beware not uninstall too much though.
Identified situations where it will be more tricky are:
When the OCaml compiler version requirement changes. In this case, you have several possibilities:
Be explicit about the “upgrade” and do
opam upgrade --unlock-base ocaml.$new_version tezos
. Note that starting from OPAM version 2.1, this option is replaced by--update-invariant
(see the opam-switch manual).Remove the existing switch (e.g.,
opam switch remove for_tezos
, but be aware that this will delete the previous installation), and replay the installation instructions.Replay the installation instructions while creating a different switch (e.g.
ocaml_${ocaml_version}_for_tezos
), but be aware that each switch consumes a significant amount of disk space.
When there are Rust dependencies involved. The way to go is still unclear. The solution will be defined when delivering the first release with Rust dependencies.
Setting up the development environment from scratch¶
If you plan to contribute to the Octez codebase, the way to go is to set up a complete development environment, by cloning the repository and compiling the sources using the provided makefile.
TL;DR: From a fresh Debian Bullseye x86_64, you typically want to select a source branch in the Octez repository, e.g.:
REPO="tezos/tezos"
BRANCH="latest-release"
and then do:
# [Temporary fix: removes tezos folder from PATH if added with Octez <= v13 instructions]
PATH=${PATH##"$HOME"/tezos/:}
sudo apt-get install -y rsync git m4 build-essential patch unzip wget opam jq bc
# [install rust]
wget https://sh.rustup.rs/rustup-init.sh
chmod +x rustup-init.sh
./rustup-init.sh --profile minimal --default-toolchain 1.64.0 -y
# [source cargo]
. $HOME/.cargo/env
# [get sources]
git clone https://gitlab.com/"$REPO".git tezos
cd tezos
git checkout $BRANCH
# [install Octez dependencies]
opam init --bare
make build-deps
# [compile sources]
eval $(opam env)
make
# [optional setup]
# puts Octez binaries in PATH:
# export PATH=$PWD/_build/install/default/bin/:$PATH
# if using bash, enables autocompletion:
# source ./src/bin_client/bash-completion.sh
# removes Mainnet/testnet disclaimers:
# export TEZOS_CLIENT_UNSAFE_DISABLE_DISCLAIMER=Y
Warning
If you are updating to Octez v14
using a development environment which had been used to build Octez
versions up to v13.x, and also you have previously exported the
tezos
directory to the $PATH
environment variable, the
following stanza is necessary to avoid potential issues with opam
in the make build-deps
step:
PATH=${PATH##"$HOME"/tezos/:}
Otherwise, it is possible for make build-deps
to fail with the
following (or a similar) error:
make: opam: Permission denied
Makefile:53: *** Unexpected opam version (found: , expected: 2.*). Stop.
The following sections describe the individual steps above in more detail.
Note
Besides compiling the sources, it is recommended to also install Python and some related tools, which are needed, among others, to build the documentation and to use the Git pre-commit hook.
Install Rust¶
Compiling Octez requires the Rust compiler (see recommended version in variable
$recommended_rust_version
in file scripts/version.sh
) and the
Cargo package manager to be installed. If you have rustup installed, it should work without any
additional steps on your side. You can use rustup to install both. If you do not have rustup
,
please avoid installing it from Snapcraft; you can rather follow the
simple installation process shown below:
wget https://sh.rustup.rs/rustup-init.sh
chmod +x rustup-init.sh
./rustup-init.sh --profile minimal --default-toolchain 1.64.0 -y
Once Rust is installed, note that your PATH
environment variable
(in .profile
) may be updated and you will need to restart your session
so that changes can be taken into account. Alternatively, you can do it
manually without restarting your session:
. $HOME/.cargo/env
Note that the command line above assumes that rustup
installed Cargo in $HOME/.cargo
, but this may change depending on how
you installed rustup. See the documentation of your rustup distribution
if file .cargo
does not exist in your home directory.
Install Zcash Parameters¶
Octez binaries require the Zcash parameter files to run.
Docker images come with those files, and the source distribution also
includes those files. But if you compile from source and move Octez to
another location (such as /usr/local/bin
), the Octez binaries may
prompt you to install the Zcash parameter files. The easiest way is to
download and run this script:
wget https://raw.githubusercontent.com/zcash/zcash/master/zcutil/fetch-params.sh
chmod +x fetch-params.sh
./fetch-params.sh
The node will try to find Zcash parameters in the following directories, in this order:
$XDG_DATA_HOME/.local/share/zcash-params
$XDG_DATA_DIRS/zcash-params
(if$XDG_DATA_DIRS
contains several paths separated by colons:
, each path is considered)$OPAM_SWITCH_PREFIX/share/zcash-params
./_opam/share/zcash-params
~/.zcash-params
~/.local/share/zcash-params
/usr/local/share/zcash-params
/usr/share/zcash-params
If the node complains that it cannot find Zcash parameters, check that
at least one of those directories contains both files sapling-spend.params
and sapling-output.params
. Here is where you should expect to find those files:
if you are compiling from source, parameters should be in
_opam/share/zcash-params
(you may need to runeval $(opam env)
before running the node);if you used
fetch-params.sh
, parameters should be in~/.zcash-params
.
Note
Some operating systems may not be covered by the list of directories above.
If Zcash is located elsewhere on your system (typically, on MacOS X), you may try creating a symbolic link such as: ln -s ~/Library/Application\ Support/ZcashParams ~/.zcash-params
.
Note that the script fetch-params.sh
downloads a third file containing parameters for Sprout (currently called sprout-groth16.params
), which is not loaded by Sapling and can be deleted to save a significant amount of space (this file is much bigger than the two other files).
Get the sources¶
Octez git
repository is hosted at GitLab. All development happens here. Do
not use our GitHub mirror
which we don’t use anymore and only mirrors what happens on GitLab.
Checkout the latest-release
branch to use the latest release.
Alternatively, you can checkout a specific version based on its tag.
Install Octez dependencies¶
Install the OCaml compiler and the libraries that Octez depends on:
make build-deps
Alternatively, if you want to install extra
development packages such as merlin
, you may use the following
command instead:
make build-dev-deps
Note
These commands create a local OPAM switch (
_opam
folder at the root of the repository) where the required version of OCaml and OCaml Octez dependencies are compiled and installed (this takes a while but it’s only done once).Be sure to
eval $(scripts/env.sh)
when youcd
into the repository in order to be sure to load this local environment.As the opam hook would overwrite the effects of
eval $(scripts/env.sh)
the script will disable the opam hook temporarily.OPAM is meant to handle correctly the OCaml libraries but it is not always able to handle all external C libraries we depend on. On most systems, it is able to suggest a call to the system package manager but it currently does not handle version checking.
As a last resort, removing the
_opam
folder (as part of agit clean -dxf
for example) allows to restart in a fresh environment.
Compile¶
Once the dependencies are installed we can update OPAM’s environment to refer to the new switch and compile the project:
eval $(opam env)
make
Lastly, you can also add the Octez binaries to your PATH
variable,
and after reading the Disclaimer a few
hundred times you are allowed to disable it with
TEZOS_CLIENT_UNSAFE_DISABLE_DISCLAIMER=Y
.
You may also activate Bash autocompletion by executing:
source ./src/bin_client/bash-completion.sh
Warning
Note that if your shell is zsh
, you may need extra configuration to customize shell
completion (refer to the zsh
documentation).
Update¶
For updating to a new version, you typically have to
update the sources by doing git pull
in the tezos/
directory and replay
the compilation scenario starting from make build-deps
.
You may also use make clean
(and rm -Rf _opam/
if needed) before that, for restarting compilation in a
fresh state.