fatalerrors/init.sh
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

updated documentation

Browse Source
This commit is contained in:
fatalerrors
2021-09-24 09:43:44 +02:00
committed by levasseur
parent 3915c4f331
commit 64c2340b52
2 changed files with 86 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,7 +2,7 @@
**init.sh** is an automated configurator for system administrators. It's fully
written using Bash scripting and aims to be platform independent. Nevertheless,
it's requirements turns it naturally to Linux systems. It have long been tested
using Debian GNU/Linux, Devuan and different flavor of Ubuntu.
using Debian GNU/Linux, Devuan and different flavors of Ubuntu.
## Getting started
You should consider reading that document entirely before use. If you need
@@ -60,15 +60,18 @@ be customized using the LOGFILE environement variable.
- **-v, --version**: Display version information, including available module
list and their version.
The options cannot be concatenated like most of Unix binaries allows. For
exemple you cannot write "*-rR*", you have to write "*-r -R*".
### Loading order and process
The first thing the script do is loading its libraries contained in the "lib"
The first thing the script do is loading its libraries contained in the "*lib*"
directory. Any file situated in that directory ending with the .sh extention
will be loaded in alphabetical order. For that reason, error management
functions are placed in a file called aaa_error.sh, so it can be loaded first
and catch errors that could occurs while loading library files. In the opposite
the zzz_main_fct.sh file have to be loaded last, because it's widely using
previously declared libraries.
and catch errors that could occurs while loading others library files. In the
opposite the zzz_main_fct.sh file have to be loaded last, because it's widely
using previously declared libraries.
After that, a basic command line parameter treatment is done. That allows the
use of --version and --help options in user space. Those options just display
@@ -84,9 +87,9 @@ Finally checking processes are launched in their declaration order (cf.
configuration file). If no error occurs and after a confirmation prompt, final
treatment processes, those that actually makes changes, are launched.
Without the --keep-going option any error will imediatelly stop execution. Some
errors that could make the script impossible to execute will stop execution,
even if the --keep-going option is provided.
Without the *--keep-going* option any error will imediatelly stop execution.
Some errors that could make the script impossible to execute will stop
execution, even if the *--keep-going* option is provided.
### Main configuration file
@@ -102,7 +105,7 @@ module you will use. Please refer to module header to see what's available for
your use case.
After a module version upgrade you should check again headers as variable name
or stucture might change. A variable ca also be deleted, new variables could
or stucture might change. A variable can also be deleted, new variables could
appears, and so on.
It is heavily recommended to use includes technique to shorten your