b5938: tweak readme and build-crontab description

This commit is contained in:
Thomas committed 2024-01-11 10:39:48 +00:00
1 parent ba5b18884a
commit bdf383451f
2 files changed
+10 -6

No files matched your search

+4 -1
View File
@@ -1,5 +1,8 @@
The environments_scripts directory contains more directories, which map to environment types, each holding scripts and files useful to that environment. Each environment type also contains a "users" folder, which contains subfolders for each user on the system.
The build-crontab script uses the contents of these subfolders to create and install a customised crontab for each user in the folder. It does this by concatenating one liner crontabs into an uber crontab.
Any time the crontab should contain a user's home directory, instead write PATH_OF_HOME_DIR_TO_REPLACE; if the crontab should
contain the path to the git directory, instead write PATH_OF_GIT_HOME_DIR_TO_REPLACE.
These are replaced by the build-crontab script with the correct paths
environment_scripts (directory)
|
@@ -10,4 +13,4 @@ environment_scripts (directory)
|
|_user1 (directory)
|
|_symbolicLinks (to configuration/crontabs)
|_symbolicLinks (to configuration/crontabs)
@@ -1,10 +1,11 @@
#!/bin/bash
# Purpose: This script iterates over an environments' USER folders, concatenating all the symbolic
# links (referencing locations within configuration/crontabs) into one file for each user. It takes the git home dir
# as well as the name of the dir within the home user. The created files for each user go into that user's
# home dir and are installed for that user too.
# Useful files are also copied across.
# Purpose: The first parameter is an image type. This script iterates over the image types' USER folders, concatenating all the symbolic
# links (referencing locations within configuration/crontabs) into one file for each user. It also takes the name of the user containing a copy of the git repo
# as well as the name of the dir within that user to go to. The created files for each user go into that user's
# home dir and are installed for that user too. Note: within these crontabs are certain regexes, which are replaced by the path to the git home dir and the matching
# user's home.
# Useful files are also copied across from the "files" dir within each image type.
if [[ $# -ne 3 && $# -ne 4 ]]; then
echo "$0 <ENVIRONMENT_TYPE> <USER_WITH_CODE> <NAME_OF_GIT_DIR> "