mirror of
https://github.com/m8tin/cis.git
synced 2025-12-06 15:58:26 +01:00
manuals first files
This commit is contained in:
30
manual/README.md
Normal file
30
manual/README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
Manual
|
||||
======
|
||||
|
||||
Each script `${FULL_SCRIPTNAME}.sh` has it's corresponding manual here:
|
||||
- `manuals/${FULL_SCRIPTNAME}.sh.md`
|
||||
|
||||
According to the rule above, this directory `manuals/core/*`
|
||||
has the same structure as `../core/*` and contains all manuals explaining the core functionality.
|
||||
|
||||
And this directory `manuals/script/*`
|
||||
has the same structure as `../script/*` and contains all manuals explaining the purpose of each script.
|
||||
|
||||
|
||||
|
||||
Core functionality
|
||||
------------------
|
||||
|
||||
This set of scripts is the absolute minimum to provide the core functionality:
|
||||
- `setupCoreOntoThisHost.sh` bootstraps an empty new host, after the scripts repository was cloned
|
||||
[Read this for further details](./setupCoreOntoThisHost.sh.md)
|
||||
- `setupCoreOntoThisHost.sh` needs [`../core/addAndCheckGitRepository.sh`](./core/addAndCheckGitRepository.sh.md)
|
||||
- `setupCoreOntoThisHost.sh` needs [`../core/addNormalUser.sh`](./core/addNormalUser.sh.md)
|
||||
- `setupCoreOntoThisHost.sh` needs [`../core/addToCrontabEveryHour.sh`](./core/addToCrontabEveryHour.sh.md)
|
||||
- `setupCoreOntoThisHost.sh` needs [`../core/defineAuthorizedKeysOfUser.sh`](./core/defineAuthorizedKeysOfUser.sh.md)
|
||||
- `setupCoreOntoThisHost.sh` needs [`../core/ensureUsageOfDefinitions.sh`](./core/ensureUsageOfDefinitions.sh.md)
|
||||
|
||||
|
||||
|
||||
The scripts
|
||||
-----------
|
||||
Reference in New Issue
Block a user