This repo provides various form of distribution for tezos-related executables:
tezos-clienttezos-admin-clienttezos-nodetezos-bakertezos-accusertezos-endorsertezos-signertezos-codectezos-sandbox
Daemon binaries (as well as packages for them) have suffix that defines their target protocol,
e.g. tezos-baker-007-PsDELPH1 can be used only on the chain with 007 protocol.
Other binaries can be used with all protocols if they're new enough. E.g.
007 protocol is supported only from v7.4. tezos-node can be set up to run
different networks, you can read more about this in this article.
- Static linux binaries
- Native Ubuntu packages
- Native Fedora packages
- Other linux
- Brew tap for macOS
- Systemd services for Tezos binaries
- Building instructions
- Setting up baking instance on Ubuntu
Recomended way to get these binaries is to download them from assets from github release. Go to the latest release and download desired assets.
Some of the individual binaries contain protocol name to determine with which protocol binary is compatible with. If this is not the case, then consult release notes to check which protocols are supported by that binary.
If you are using Ubuntu you can use PPA in order to install tezos-* executables.
E.g, in order to do install tezos-client or tezos-baker run the following commands:
sudo add-apt-repository ppa:serokell/tezos && sudo apt-get update
sudo apt-get install tezos-client
# dpkg-source prohibits uppercase in the packages names so the protocol
# name is in lowercase
sudo apt-get install tezos-baker-007-psdelph1
Once you install such packages the commands tezos-* will be available.
If you have a Raspberry Pi running the 64bit version of the official OS, you can
use the Lauchpad PPA to install tezos-* executables on it as well.
You can add the PPA using:
# Intall software properties commons
sudo apt-get install software-properties-common
# Add PPA with Tezos binaries
sudo add-apt-repository 'deb http://ppa.launchpad.net/serokell/tezos/ubuntu bionic main'
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 37B8819B7D0D183812DCA9A8CE5A4D8933AE7CBB
sudo apt-get update
And install packages with apt-get, e.g. for tezos-client:
sudo apt-get install tezos-client
If you are using Fedora you can use Copr in order to install tezos-*
executables.
E.g. in order to install tezos-client or tezos-baker run the following commands:
# use dnf
sudo dnf copr enable @Serokell/Tezos
sudo dnf install tezos-client
sudo dnf install tezos-baker-007-PsDELPH1
# or use yum
sudo yum copr enable @Serokell/Tezos
sudo yum install tezos-baker-007-PsDELPH1
Once you install such packages the commands tezos-* will be available.
Download binaries from release assets.
Make it executable:
chmod +x tezos-client
Run ./tezos-client or add it to your PATH to be able to run it anywhere.
If you're using macOS and brew, you can install Tezos binaries from the taps provided
by this repository. There are two taps: one for the latest stable release of Tezos and
one for the latest release candidate of Tezos.
In order to use latest stable version run the following:
brew tap serokell/tezos-packaging-stable https://github.com/serokell/tezos-packaging-stable.git
In order to use latest release candidate version run the following:
brew tap serokell/tezos-packaging-rc https://github.com/serokell/tezos-packaging-rc.git
Once the desired tap is selected, you can install the chosen package, e.g.:
brew install tezos-client
It's possible to provide prebuilt macOS packages for brew called bottles. They're supposed
to be built before making the new release and included to it. In order to build all bottles run
build-bottles.sh script:
./scripts/build-bottles.sh
Note that this might take a while, because builds don't share common parts and for each binary dependencies are compiled from scratch. Once the bottles are built, the corresponding sections in the formulas should be updated. Also, bottles should be uploaded to the release artifacts.
tezos-node, tezos-accuser-<proto>, tezos-baker-<proto>,
tezos-endorser-<proto>, and tezos-signer packages have systemd files included to the
Ubuntu and Fedora packages.
As an addition, tezos-baking package provides tezos-baking-<network> services that orchestrate
systemd units for tezos-node, tezos-baker-<proto>, and tezos-endorser-<proto>.
Configuration files for these services are located in /etc/default/tezos-baking-<network>.
Once you've installed the packages with systemd unit, you can run the service with the binary from the package using the following command:
systemctl start <package-name>.service
To stop the service run:
systemctl stop <package-name>.service
Each service has configuration file located in /etc/default. Default
configurations can be found here.
Files created by the services will be located in /var/lib/tezos/ by default.
tezos-{accuser, baker, endorser}-<protocol> services can have configurable
data directory.
tezos-{accuser, endorser} have configurable node address, so that they can be used with both
remote and local node.
tezos-accuser-<proto>, tezos-baker-<proto>, tezos-endorser-<proto> formulas
provide backround services for running the corresponding daemons.
Since tezos-node and tezos-signer need multiple services they are provided
in dedicated meta-formulas. These formulas don't install any binaries and only add
background services.
Formulas with tezos-node background services:
tezos-node-mainnet
Formulas with tezos-signer background services:
tezos-signer-httptezos-signer-httpstesos-signer-tcptezos-signer-unix
To start the service: brew services start <formula>.
To stop the service: brew services stop <formula>.
All of the brew services have various configurable env variables. These variables
can be changed in the corresponding /usr/local/Cellar/tezos-signer-tcp/<version>/homebrew.mxcl.<formula>.plist.
Once the configuration is updated, you should restart the service:
brew services restart <formula>.
Note, that all services are run as a user agents, thus they're stopped after the logout.
If you're not using Ubuntu or Fedora you can still construct systemd units for binaries from scratch.
For this you'll need .service file to define systemd service. The easiest way
to get one is to run gen_systemd_service_file.py.
You should specify service name as an argument. Note that there are three
predefined services for tezos-node: tezos-node-{mainnet, delphinet}.
E.g.:
./gen_systemd_service_file.py tezos-node-mainnet
# or
./gen_systemd_service_file.py tezos-baker-007-PsDELPH1
After that you'll have .service file in the current directory.
Apart from .service file you'll need service startup script and default configuration
file, they can be found in scripts and
defaults folders respectively.
It's possible to run multiple same services, e.g. two tezos-nodes that run different
networks.
tezos-node packages provide multiple services out of the box:
tezos-node-florencenet and tezos-node-mainnet that run
florencenet and mainnet networks respectively.
In order to start it run:
systemctl start tezos-node-<network>
Also, there are tezos-node-<network> binary aliases that are equivalent to
TEZOS_NODE_DIR="<DATA_DIR from tezos-node-<network>.service>" tezos-node
In addition to node services where the config is predefined to a specific network
(e.g. tezos-node-mainnet or tezos-node-florencenet), it's possible to run tezos-node-custom
service and provide a path to the custom node config file via the
CUSTOM_NODE_CONFIG variable in the tezos-node-custom.service file.
Another case for running multiple similar systemd services is when one wants to have multiple daemons that target different protocols. Since daemons for different protocols are provided in the different packages, they will have different service files. The only thing that needs to be changed is config file. One should provide desired node address, data directory for daemon files and node directory (however, this is the case only for baker daemon).
tezos-signer package provides four services one for each mode in which signing daemon can run:
- Over TCP socket (
tezos-signer-tcp.service). - Over UNIX socker (
tezos-signer-unix.service). - Over HTTP (
tezos-signer-http.service). - Over HTTPS (
tezos-signer-https.service) Each signer service has dedicated config file in e.g./etc/default/tezos-signer-{mode}.
This repository provides two distinct ways for building and packaging tezos binaries:
Read the article to find out an easy way to set up baking instance on Ubuntu using packages provided by our launchpad PPA.
Please see CONTRIBUTING.md for more information.
This repository is maintained with ❤️ by Serokell. The names and logo for Serokell are trademark of Serokell OÜ.
We love open source software! See our other projects or hire us to design, develop and grow your idea!