From c37cc7cd9eabbd13e447e26ccfbb9bcf4120ed28 Mon Sep 17 00:00:00 2001 From: Pietro Abate Date: Mon, 11 Mar 2024 10:27:44 +0100 Subject: [PATCH 1/2] doc: Update install instructions for deb and rpm --- docs/introduction/howtoget.rst | 94 +++++++++++++++------------------- 1 file changed, 42 insertions(+), 52 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 1483fed2f1ad..21361292664d 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -66,75 +66,65 @@ Installing binaries ------------------- Depending on your operating system, you may install Octez (dynamically-linked) -binaries and their dependencies using a package manager, as follows. +binaries and their dependencies by first downloading the packages for your +distribution from the `Octez release page +`__, browsing to your distribution +and then installing them with your package tool manager. Most of the +configuration options are accessible by the user in ``/etc/default/``. -Ubuntu Launchpad PPA with Octez packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +If you are upgrading from a different package distributor such as `Serokell's tezos-packaging`__, +please pay attention to the possible differences between the two packages, in +particular regarding the home directory for the ``tezos`` user. -If you're using Ubuntu, you can install packages with Octez binaries from a Launchpad PPA. -Currently it supports Jammy and Focal versions. +There are several packages: -In order to add the stable release PPA repository to your machine, do: +- ``octez-client``: the client for manipulating wallets and signing items +- ``octez-node``: the Octez node +- ``octez-baker``: the Octez baking and VDF daemons +- ``octez-smartrollup``: the Octez Smart Rollup daemons +- ``octez-signer``: the remote signer, to hold keys on (and sign from) a different machine from the baker or client -.. literalinclude:: install-bin-ubuntu.sh - :language: shell - :start-after: [setup stable repository] - :end-before: [end] +Also there are some experimental packages: -Alternatively, to add the release candidates PPA instead, do: +- ``octez-experimental`` - binaries that are considered experimental including + the Alpha baker +- ``octez-evm-node`` - the EVM endpoint node for Etherlink -.. literalinclude:: install-bin-ubuntu.sh - :language: shell - :start-after: [setup rc repository] - :end-before: [end] +The packages are set up to run under a dedicated user. The ``octez-node``, +``octez-baker`` and ``octez-smartrollup`` packages use a user and group called +tezos. The ``octez-signer`` package uses a user and group called tzsigner. It’s +possible to configure the software to use a different user (even root). -Then, to install the binaries, run the following commands: +The documentation for these packages, originally developed by Chris Pinnock, +can be found here: https://chrispinnock.com/tezos/packages/ -.. literalinclude:: install-bin-ubuntu.sh - :language: shell - :start-after: [install tezos] - :end-before: [test executables] +Ubuntu and Debian Octez packages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Upgrading to a newer release is made easy by the APT package manager, using -commands such as ``apt-get update``, ``apt-get upgrade ``, and -``apt-get install ``. 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``. +If you're using Ubuntu or Debian, you can install packages with Octez binaries +using ``dpkg`` or ``apt``. Currently it supports the two latest LTS releases +for Ubuntu and for Debian, the stable and testing release. -Fedora Copr repository with Octez packages -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Upgrading to a newer release requires downloading again all the ``deb`` +packages and repeat the installation. -If you're using Fedora, you can install packages with Octez binaries from a Copr repository. -Currently it supports Fedora 37 and 38. +For example using dpkg:: -In order to add the stable Copr repository to your machine, do: + dpkg -i octez-client_19.1-1_arm64.deb -.. literalinclude:: install-bin-fedora.sh - :language: shell - :start-after: [setup stable repository] - :end-before: [end] - -Alternatively, to add the release candidates Copr repository instead, do: +Fedora Octez packages +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. literalinclude:: install-bin-fedora.sh - :language: shell - :start-after: [setup rc repository] - :end-before: [end] +If you're using Fedora, you can install packages with Octez binaries +using ``rpm`` or ``dnf``. Currently it supports the latest LTS release for +Fedora and for RockyLinux. -Then, to install the binaries, run the following commands: +Upgrading to a new or more recent release requires downloading again all the ``rpm`` +packages and repeat the installation. -.. literalinclude:: install-bin-fedora.sh - :language: shell - :start-after: [install tezos] - :end-before: [test executables] +For example using ``yum``:: -Upgrading to a newer release is made easy by the DNF package manager, using -commands such as ``dnf upgrade ``, and -``dnf install ``. 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``. + yum install ./octez-client-19.1-1.x86_64.rpm .. _using_docker_images: -- GitLab From 69593317263d7688c1564adaef57ea4887f83aa3 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 15 Mar 2024 17:57:16 +0000 Subject: [PATCH 2/2] doc: fix RST external link --- docs/introduction/howtoget.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 21361292664d..a29984d65143 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -72,7 +72,7 @@ distribution from the `Octez release page and then installing them with your package tool manager. Most of the configuration options are accessible by the user in ``/etc/default/``. -If you are upgrading from a different package distributor such as `Serokell's tezos-packaging`__, +If you are upgrading from a different package distributor such as `Serokell's tezos-packaging `__, please pay attention to the possible differences between the two packages, in particular regarding the home directory for the ``tezos`` user. -- GitLab