From 0ebb8d453fd375ff19903361310b5988a56fc1a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Lesimple?= Date: Fri, 6 Nov 2020 11:27:49 +0000 Subject: [PATCH] doc: adjust ttyrec install section --- doc/sphinx/installation/basic.rst | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/sphinx/installation/basic.rst b/doc/sphinx/installation/basic.rst index 1dc805e..52ecef3 100644 --- a/doc/sphinx/installation/basic.rst +++ b/doc/sphinx/installation/basic.rst @@ -68,7 +68,7 @@ For the supported Linux distros (see above), you can simply run: .. code-block:: shell - /opt/bastion/bin/admin/packages-check.sh -i + /opt/bastion/bin/admin/packages-check.sh -i You can add other parameters to install optional packages, depending on your environment: @@ -76,7 +76,13 @@ You can add other parameters to install optional packages, depending on your env - ``-d`` to install packages needed for developing the software (useless in production) - ``-t`` to install ``ovh-ttyrec`` -Note that ``-t`` makes the assumption that you have made available ``ovh-ttyrec`` to your distro repositories. If you haven't omit the ``-t`` and check the `ovh-ttyrec code repository `_'s readme section titled "*build a .deb package*" for instructions on how to do so (spoiler: it's a oneliner). +Note that ``-t`` makes the assumption that you have compiled and made available ``ovh-ttyrec`` to your distro repositories. If you haven't, you can use the following helper: + +.. code-block:: shell + + /opt/bastion/bin/admin/install-ttyrec.sh -a + +This will detect your distro, then download and either install the ``.deb`` or ``.rpm`` package for `ovh-ttyrec `_. If your distro doesn't handle those package types, it'll fallback to installing precompiled static binaries. Of course you can package it yourself and make it available to your own internal repositories instead of installing it this way. 4. Encrypt /home ================