This repository is a collection of simple scripts used in a local organisation called XP Ängelholm to simplify administrative tasks as well as to enhance the security of ggLeap, e.g by removing user details when a user signs out. A large quantity of the users possess limited technical abilities, therefore have certain decisions been made, such as separating tools with a simple usage and more advanced tools, such as standalone applications.
Utilising Batch and PowerShell accomplishes the goal of minimising the prerequisites due to no additional installation being required as well as simplifying the process of enabling and disabling each script through the web interface accompanying ggLeap.
- A simple installation with no additional prerequisites.
- Security enhancements to ggLeap.
- Additional features to ggLeap, such as an auditory reminder that the establishment is closing soon.
- Tools to simplify administrative tasks related to ggLeap, such as removing profile pictures in Windows.
- PowerShell
- Batch
- Open the web portal of ggLeap.
- Click on Settings.
- Click on Client configuration.
- Click on Advanced.
- Either delete or alter the paths to become incorrect.
These scripts are designed to be executed during startup and deletes user information to forcefully logout users of applications not affected by a similar process done by ggLeap.
windows-profile-picture-removal can be used to quickly remove profile pictures from computers with pictures due to people logging into Windows and Microsoft. This script can be disabled until a profile picture is required to be deleted. Instructions on how to enable and disable can be found here.
15-minutes-remaining-warning reminds the visitors that the establishment closes in 15 minutes by playing a sound. This script should be configured to be executed over an extended amount of time, in the web interface of ggLeap.
The scripts found in installer-scripts are used to simplify the install process for the other scripts. A separate folder is used instead of dividing the install scripts based on usage to simplify the main install script as well as enabling individual downloads.
The build process is initiated by executing build.ps1 and the latest build is found in the folder called distribution.
- Start the computer in administrator mode.
- Go to the page containing releases.
- Click on distribution.zip under Assets to start the download. Choose the latest version.
- Extract the ZIP file.
- Open the resulting folder.
- Ensure all computers are assigned a security group allowing the execution of Batch and PowerShell, in the web interface.
- Click on main-installer.exe.
- Open installer-scripts.
- Click on each file separately.
- Follow step one to four under How to enable and disable scripts.
- Add the installation path of each script to all computers, and ensure each path is consistent throughout all computers.
Create a release by:
- Create a commit, starting with any of the keywords found below and adhering to this pattern
<the desired keyword>: <the commit message>. - Execute
git tag v<the version number>. - Execute
git push <the name of the remote> <the version number>.
| Version type | Trigger in commit message | What it updates | Example change |
|---|---|---|---|
| Major | BREAKING CHANGE |
Increments the major version, resets minor and patch to 0. |
Refactoring core components that are not backward compatible. |
| Minor | feat |
Increments the minor version, resets patch to 0. |
Adding a new feature that does not break backward compatibility. |
| Patch | fix |
Increments the patch version. | Fixing bugs or making minor improvements. |