Merge pull request #39 from ovh/release

release v3.00.01

AUTHORS

@@ -1,4 +1,4 @@
-# This is the official list of OVH::Bastion authors for copyright purposes.
+# This is the official list of The Bastion authors for copyright purposes.
 # This file is distinct from the CONTRIBUTORS files
 # and it lists the copyright holders only.
 

CONTRIBUTORS

@@ -1,5 +1,5 @@
 # This is the official list of people who can contribute
-# (and typically have contributed) code to the OVH::Bastion repository.
+# (and typically have contributed) code to The Bastion repository.
 #
 # Names should be added to this file only after verifying that
 # the individual or the individual's organization has agreed to

doc/CHANGELOG.md

@@ -1,2 +1,11 @@
+## v3.00.01 - 2020/11/06
+- feat: add OpenSUSE 15.2 to the officially supported distros
+- enh: install-ttyrec.sh: replaces build-and-install-ttyrec.sh, no longer builds in-place but prefers .deb and .rpm packages & falls back to precompiled static binaries otherwise
+- enh: packages-check.sh: add qrencode-libs for RHEL/CentOS
+- enh: provide a separated Dockerfile for the sandbox, squashing useless layers
+- doc: a lot of fixes here and there
+- chore: remove spurious config files
+- chore: a few GitHub actions workflow fixes
+
 ## v3.00.00 - 2020/10/30
 - First public release \o/

doc/HIERARCHY.md

@@ -1,7 +1,7 @@
 man 7 hier
 ==========
 
-The OVH::Bastion directory hierarchy is organized as follows:
+The Bastion directory hierarchy is organized as follows:
 
 - bin
   - bin/admin: scripts that are supposed to be launched manually by an admin where needed
@@ -19,9 +19,9 @@ The OVH::Bastion directory hierarchy is organized as follows:
   - bin/shell: where resides the main script that is declared as the shell of the bastion users, with some of its helpers
   - bin/sudogen: where resides the helper script that generate group and account sudoers files
   - bin/other: other helper scripts for various tasks
-- contrib: placeholder directory with a readme file that references other repositories of interest when integrating the bastion in your company
+- contrib: third-party files that might be of interest integrating The Bastion in your company
 - doc: sysadmin-proof documentation folder, the main Markdown files you need are there, just one `view` apart
-  - doc/sphinx: more complete documentation using the `sphinx` documentation system, the built version is viewable on https://ovh.github.io/the-bastion/
+  - doc/sphinx: more complete documentation using the `sphinx` documentation system, the built version is viewable on https://ovh.github.io/the-bastion/, otherwise the `.rst` files can be read with any text editor
 - docker: where the Dockerfiles reside
 - etc: contains all the template configuration files that will be installed on your system (depending on your `install` options)
 - install: where optional modules can push their install script to be called by the main install script

doc/INSTALL.md

@@ -0,0 +1,5 @@
+# Install instructions
+
+Please refer to proper section of the [documentation](https://ovh.github.io/the-bastion/installation/basic.html).
+
+It can also be found offline, in the ``doc/sphinx/installation/basic.rst`` text file.

doc/UPGRADE.md

@@ -0,0 +1,11 @@
+# General upgrade instructions
+
+Please refer to proper section of the [documentation](https://ovh.github.io/the-bastion/installation/upgrading.html).
+
+It can also be found offline, in the ``doc/sphinx/installation/upgrading.rst`` text file.
+
+# Specific upgrade instructions
+
+Each version might have specific upgrade instructions, please refer to the proper section of the [documentation](https://ovh.github.io/the-bastion/installation/upgrading.html#version-specific-upgrade-instructions).
+
+It can also be found offline, in the ``doc/sphinx/installation/upgrading.rst`` text file.

doc/sphinx/installation/upgrading.rst

@@ -42,7 +42,17 @@ Note that this is done automatically for bastion admins.
 Version-specific upgrade instructions
 =====================================
 
+v3.00.01
+********
+
+If you previously installed ``ttyrec`` using the now deprecated ``build-and-install-ttyrec.sh`` script, you might want to know that since this version, the script has been replaced by ``install-ttyrec.sh``, which no longer builds in-place, but prefers downloading and installing prebuild ``rpm`` or ``deb`` packages.
+
+If you previously built and installed ``ttyrec`` manually, and want to use the new packages instead, you might want to manually uninstall your previously built ttyrec program (remove the binaries that were installed in ``/usr/local/bin``), and call ``install-ttyrec.sh -a`` to download and install the proper package instead.
+
+This is not mandatory and doesn't change anything from the software point of view.
+
+
 v3.00.00
 ********
 
-Initial public version, no specific upgrade instructions
+Initial public version, no specific upgrade instructions.

lib/perl/OVH/Bastion.pm

@@ -5,7 +5,7 @@ use common::sense;
 use Fcntl;
 use POSIX qw(strftime);
 
-our $VERSION = '3.00.00';
+our $VERSION = '3.00.01';
 
 BEGIN {
     # only used by the handler below