ovh/the-bastion
1
1
Fork 0
mirror of https://github.com/ovh/the-bastion.git synced 2024-11-10 09:12:54 +08:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #37 from ovh/doc

Browse source 
doc: adjust ttyrec install section
This commit is contained in:
Stéphane Lesimple 2020-11-06 13:36:18 +01:00 committed by GitHub
commit 8d5b223ce4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/sphinx/installation/basic.rst
View file

@ -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 <https://github.com/ovh/ovh-ttyrec>`_'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 <https://github.com/ovh/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
================