diff --git a/home/.chezmoiscripts/universal/run_onchange_after_04-environment-profile.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_04-environment-profile.sh.tmpl index ca829732..f41d530b 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_04-environment-profile.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_04-environment-profile.sh.tmpl @@ -1,6 +1,6 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash -# @file `/etc/environment` Setup +# @file Global Profile Setup # @brief Configures `/etc/environment` to include environment variables that should be applied globally # @description # This script modifies the `/etc/environment` file on Linux devices to include: diff --git a/home/.chezmoiscripts/universal/run_onchange_after_05-log-config.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_05-log-config.sh.tmpl index dd30a677..a66561a3 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_05-log-config.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_05-log-config.sh.tmpl @@ -1,6 +1,6 @@ {{- if (ne .host.distro.family "windows") -}} #!/usr/bin/env bash -# @file `/var/log/user` Folders +# @file User Log Folders # @brief Creates an empty directory for each user in `/var/log/user` # @description # This script creates an empty directory with each user's name in `/var/log/user`. It initializes the folder in hopes diff --git a/home/.chezmoiscripts/universal/run_onchange_after_06-bin-symlink.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_06-bin-symlink.sh.tmpl index 17a8dd0b..a54c7483 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_06-bin-symlink.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_06-bin-symlink.sh.tmpl @@ -6,7 +6,8 @@ # This script checks if `python3` is available and if `python` is not available. If both are true, then the script # symlinks `python` to `python3` so that the `python` command uses `python3`. # -# This is useful if you do not want to install Python 2.7 and would like Python 3 to be used in all cases. +# This is useful if you do not want to install Python 2.7 and would like Python 3 to be used in all scenarios where Python is +# invoked with the `python` command. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.sh.tmpl similarity index 74% rename from home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.sh.tmpl index 9ac6325b..315a6612 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_07-docker-plugins.sh.tmpl @@ -1,5 +1,17 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file Docker Plugins +# @brief Ensures Docker push-rm and the Docker Rclone plugin are installed +# @description +# This script sets up two different Docker plugins. +# +# 1. [Docker push-rm](https://github.com/christian-korneck/docker-pushrm) allows you to programmatically update the README.md and other Docker registry metadata on [DockerHub](https://hub.docker.com/) +# 2. [Docker Rclone plugin](https://rclone.org/docker/) allows you to mount Rclone mounts as Docker volumes +# +# ## Docker Rclone +# +# The Docker Rclone installation ensures necessary system directories are initialized / created. It also copies the [Docker Rclone configuration](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/rclone/private_docker-rclone.conf.tmpl) +# to the proper system location. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_11-symlink-ansible-roles.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_11-symlink-ansible-roles.sh.tmpl index 3244df16..8dee7df1 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_11-symlink-ansible-roles.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_11-symlink-ansible-roles.sh.tmpl @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# @file Ansible Roles / Gas Station +# @file Ansible Roles / Gas Station Symlinks # @brief Symlinks roles that are part of the [Gas Station](https://github.com/megabyte-labs/gas-station) project to a location that Ansible can digest # @description # Install Doctor was previously called Gas Station. It was also Ansible based. Some of the features that Install Doctor diff --git a/home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.sh.tmpl similarity index 87% rename from home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.sh.tmpl index 0b043af3..df9700d2 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_12-install-packages.sh.tmpl @@ -1,4 +1,8 @@ #!/usr/bin/env bash +# @file Software Package Installation +# @brief Installs the list of software that correlates to the software group that was chosen. +# @description +# This script initializes the installation process that handles the bulk of the software package installations. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_13-post-install-packages.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_13-post-install-packages.tmpl deleted file mode 100644 index c1c2d20d..00000000 --- a/home/.chezmoiscripts/universal/run_onchange_after_13-post-install-packages.tmpl +++ /dev/null @@ -1,13 +0,0 @@ -{{- if (eq .host.distro.family "linux") -}} -#!/usr/bin/env bash - -{{ includeTemplate "universal/profile" }} -{{ includeTemplate "universal/logg" }} - -### Remove Firefox snap if Flatpak is installed -if command -v org.mozilla.firefox > /dev/null && command -v snap > /dev/null && snap list firefox | grep firefox > /dev/null; then - logg info 'Removing snap version of Firefox because Flatpak version is already installed' - sudo snap remove firefox -fi - -{{ end -}} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.sh.tmpl similarity index 60% rename from home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.sh.tmpl index 430208b5..df139119 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_14-install-aqua-packages.sh.tmpl @@ -1,4 +1,8 @@ #!/usr/bin/env bash +# @file Aqua Initialization +# @brief Updates and installs any Aqua dependencies that are defined in Aqua's configuration file. +# @description +# This script updates Aqua and then installs any Aqua dependencies that are defined. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_14-keybase.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_14-keybase.sh.tmpl similarity index 73% rename from home/.chezmoiscripts/universal/run_onchange_after_14-keybase.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_14-keybase.sh.tmpl index c484e7a4..a88baf27 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_14-keybase.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_14-keybase.sh.tmpl @@ -1,5 +1,9 @@ {{- if eq .host.distro.family "linux" -}} #!/usr/bin/env bash +# @file Keybase Configuration +# @brief Updates Keybase's system configuration with the Keybase configuration stored in the `home/dot_config/keybase/config.json` location. +# @description +# This script ensures Keybase utilizes a configuration that, by default, adds a security fix. # Keybase config hash: {{ include (joinPath .chezmoi.homeDir ".config" "keybase" "config.json") | sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.sh.tmpl similarity index 69% rename from home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.sh.tmpl index 573be55f..4aa1c155 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_14-timeshift.sh.tmpl @@ -1,5 +1,9 @@ {{- if eq .host.distro.family "linux" -}} #!/usr/bin/env bash +# @file Timeshift Configuration +# @brief Updates the Timeshift system configuration with the Timeshift configuration stored in the `home/dot_config/timeshift/timeshift.json` location. +# @description +# This script applies a Timeshift configuration that defines how Timeshift should maintain system backups. # timeshift.json hash: {{ include (joinPath .chezmoi.homeDir ".config" "timeshift" "timeshift.json") | sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_14-warp.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_14-warp.sh.tmpl similarity index 71% rename from home/.chezmoiscripts/universal/run_onchange_after_14-warp.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_14-warp.sh.tmpl index 2df8623d..1504b0c2 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_14-warp.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_14-warp.sh.tmpl @@ -1,5 +1,18 @@ {{- if (ne .host.distro.family "windows") -}} #!/usr/bin/env bash +# @file CloudFlare WARP +# @brief Configures and connects the CloudFlare WARP CLI to the CloudFlare network if `warp-cli` is installed. +# @description +# This script automatically connects CloudFlare WARP CLI by first ensuring that the environment is not a WSL environment +# and also by ensuring the `warp-cli` command is available. It then: +# +# 1. Automatically accepts the Terms of Service and registers the client with CloudFlare +# 2. Automatically connects to the CloudFlare network +# 3. Ensures Always-On Mode is enabled +# 4. Enrolls the client with CloudFlare teams (if the `CLOUDFLARE_TEAMS_CLIENT_ID` and `CLOUDFLARE_TEAMS_CLIENT_SECRET` variables are provided) +# +# There are also commented lines in this script that show how you can enable WARP+DNS and Family Mode, if you decide +# to leverage CloudFlare WARP CLI for anything other than securely connecting to CloudFlare Teams. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.sh.tmpl similarity index 82% rename from home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.sh.tmpl index 301bf5ac..6e854883 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_15-install-asdf-packages.sh.tmpl @@ -1,5 +1,10 @@ #!/usr/bin/env bash {{- if (ne .host.distro.family "windows") }} +# @file ASDF Plugins / Install +# @brief Configures ASDF plugins and ensures they are pre-installed. +# @description +# This script ensures ASDF is setup and then adds the plugins specified in the `~/.tool-versions` file. After that, +# it ensures the ASDF plugins are pre-installed. # dot_tool-versions.tmpl hash: {{ include "dot_tool-versions.tmpl" | sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.sh.tmpl similarity index 66% rename from home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.sh.tmpl index 0b60cbee..69f812d6 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_18-install-sdkman.sh.tmpl @@ -1,4 +1,9 @@ #!/usr/bin/env bash +# @file SDKMAN Install +# @brief Ensures SDKMAN is installed. +# @description +# This script ensures SDKMAN (a Java version manager) is installed using the method recommended on [their +# website](https://sdkman.io/). {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.sh.tmpl similarity index 92% rename from home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.sh.tmpl index 49270222..55e153ea 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_19-gnome-extension-settings.sh.tmpl @@ -1,5 +1,10 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file GNOME Extension Settings +# @brief Applies GNOME extension settings from various data sources. +# @description +# This script ensures your GNOME extensions come pre-configured to your liking. It provides the ability +# to automatically install a configurable list of GNOME extensions as well as apply your preferred settings. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.sh.tmpl similarity index 95% rename from home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.sh.tmpl index 9fb1c768..3688a704 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_19-theme-files.sh.tmpl @@ -1,5 +1,9 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file Linux GNOME / KDE Theme +# @brief Installs the Sweet-based theme for GNOME / KDE. +# @description +# This script applies various themes to Linux systems that use GNOME or KDE. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_20-font.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_20-font.sh.tmpl similarity index 83% rename from home/.chezmoiscripts/universal/run_onchange_after_20-font.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_20-font.sh.tmpl index 4312af7e..3960429e 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_20-font.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_20-font.sh.tmpl @@ -1,5 +1,9 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file Fonts +# @brief Ensures fonts are available at the system level and, on Linux, it configures the system font settings. +# @description +# This script is utilized to ensure the same fonts are consistently used across the system. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.sh.tmpl similarity index 89% rename from home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.sh.tmpl index 9e05dd85..cfd1140a 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_21-dconf-settings.sh.tmpl @@ -1,5 +1,10 @@ {{- if eq .host.distro.family "linux" -}} #!/usr/bin/env bash +# @file DConf Settings +# @brief Applies repository-housed `dconf` settings. +# @description +# This script allows you to apply `dconf` settings that you can store in your fork of Install Doctor. By default, +# it makes a handful of `dconf` settings optimizations. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_24-vpn-linux.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_24-vpn-linux.sh.tmpl index 2143487e..f6d4a127 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_24-vpn-linux.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_24-vpn-linux.sh.tmpl @@ -18,7 +18,6 @@ # # ## Links # -# * [`run_onchange_after_24-vpn-linux.tmpl`](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_24-vpn-linux.tmpl) # * [VPN profile folder](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/vpn) # * [VPN profile documentation](https://install.doctor/docs/customization/secrets#vpn-profiles) diff --git a/home/.chezmoiscripts/universal/run_onchange_after_26-system-vscode-node-modules.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_26-system-vscode-node-modules.sh.tmpl index 8090d703..e0fb55dc 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_26-system-vscode-node-modules.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_26-system-vscode-node-modules.sh.tmpl @@ -46,7 +46,6 @@ # # ## Links # -# * [`run_onchange_after_26-system-vscode-node-modules.tmpl`](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_26-system-vscode-node-modules.tmpl) # * [`package.json` configuration file](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/Code/User/package.json) # * [StrictLint.com documentation](https://strictlint.com/docs) diff --git a/home/.chezmoiscripts/universal/run_onchange_after_26-vscode-extensions.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_26-vscode-extensions.sh.tmpl index 4add1344..f3edf8d0 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_26-vscode-extensions.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_26-vscode-extensions.sh.tmpl @@ -25,7 +25,6 @@ # # ## Links # -# * [`run_onchange_after_26-vscode-extensions.tmpl`](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_26-vscode-extensions.tmpl) # * [Visual Studio Code settings folder](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/Code/User) # * [Visual Studio Code `extensions.json`](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/Code/User/extensions.json) diff --git a/home/.chezmoiscripts/universal/run_onchange_after_27-tor.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_27-tor.sh.tmpl index 198e5c2d..2a89c27d 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_27-tor.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_27-tor.sh.tmpl @@ -13,7 +13,6 @@ # # ## Links # -# * [Script on GitHub](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_27-tor.tmpl) # * [Tor configuration](https://github.com/megabyte-labs/install.doctor/tree/master/home/dot_config/tor/torrc) # tor config hash: {{ include (joinPath .host.home ".config" "tor" "torrc") | sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_28-privoxy.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_28-privoxy.sh.tmpl index 389cf581..d4dfb9d7 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_28-privoxy.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_28-privoxy.sh.tmpl @@ -12,7 +12,6 @@ # # ## Links # -# * [Script on GitHub](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_28-privoxy.tmpl) # * [Privoxy configuration](https://github.com/megabyte-labs/install.doctor/tree/master/home/dot_config/privoxy/config) # privoxy config hash: {{ include (joinPath .host.home ".config" "privoxy" "config") | sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_40-chrome.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_40-chrome.sh.tmpl index 50a5e956..c66f4a9b 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_40-chrome.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_40-chrome.sh.tmpl @@ -22,7 +22,6 @@ # # ## Links # -# * [Script on GitHub](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_40-chrome.tmpl) # * [`managed.json`](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/chrome/managed.json) # * [`recommended.json`](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/chrome/recommended.json) diff --git a/home/.chezmoiscripts/universal/run_onchange_after_40-firefox.sh.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_40-firefox.sh.tmpl index 4912689f..fe3d7434 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_40-firefox.sh.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_40-firefox.sh.tmpl @@ -40,7 +40,6 @@ # # ## Links # -# * [Script on GitHub](https://github.com/megabyte-labs/install.doctor/blob/master/home/.chezmoiscripts/universal/run_onchange_after_40-firefox.tmpl) # * [System-wide configurations](https://github.com/megabyte-labs/install.doctor/tree/master/home/dot_local/share/firefox) as well as the location of the `profile.ini` and some other configurations # * [User-specific configurations](https://github.com/megabyte-labs/install.doctor/blob/master/home/dot_config/firefox/user.js) added to all profiles except Factory diff --git a/home/.chezmoiscripts/universal/run_onchange_after_45-vmware.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_45-vmware.sh.tmpl similarity index 92% rename from home/.chezmoiscripts/universal/run_onchange_after_45-vmware.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_45-vmware.sh.tmpl index baacac8a..55f6bf5c 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_45-vmware.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_45-vmware.sh.tmpl @@ -1,5 +1,9 @@ {{- if eq .host.distro.family "linux" -}} #!/usr/bin/env bash +# @file VMWare Configuration +# @brief Patches VMWare to leverage kernel optimizations, support macOS, and work harmoniously with Secure Boot. It also enables optional services such as the USB service. +# @description +# This script performs various VMWare optimizations that allow VMWare to work optimally with all features enabled. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.sh.tmpl similarity index 86% rename from home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.sh.tmpl index e4240333..272fda5c 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_46_virtualbox.sh.tmpl @@ -1,5 +1,9 @@ {{- if ne .host.distro.family "windows" -}} #!/usr/bin/env bash +# @file VirtualBox Extension Pack +# @brief Ensures the VirtualBox extension pack is installed. +# @description +# This script ensures the VirtualBox extension pack that corresponds with VirtualBox's version is properly installed. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_50-crontab.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_50-crontab.sh.tmpl similarity index 57% rename from home/.chezmoiscripts/universal/run_onchange_after_50-crontab.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_50-crontab.sh.tmpl index 7a44a72f..421706b4 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_50-crontab.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_50-crontab.sh.tmpl @@ -1,5 +1,9 @@ {{- if false }} #!/usr/bin/env bash +# @file Crontab Jobs +# @brief Schedules Crontab jobs by importing a configuration stored in `~/.config/crontab/config` +# @description +# This script loads crontab jobs that are defined and housed in your Install Doctor fork. # crontab config hash: {{ include (joinPath .chezmoi.homeDir ".config" "crontab" "config")| sha256sum }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_57-netdata.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_57-netdata.sh.tmpl similarity index 82% rename from home/.chezmoiscripts/universal/run_onchange_after_57-netdata.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_57-netdata.sh.tmpl index efeb3ff3..a6699b4f 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_57-netdata.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_57-netdata.sh.tmpl @@ -1,5 +1,11 @@ {{- if and (ne .host.distro.family "windows") (stat (joinPath .host.home ".config" "age" "chezmoi.txt")) (or (stat (joinPath .chezmoi.sourceDir ".chezmoitemplates" "secrets" "NETDATA_TOKEN")) (env "NETDATA_TOKEN")) (or (stat (joinPath .chezmoi.sourceDir ".chezmoitemplates" "secrets" "NETDATA_ROOM")) (env "NETDATA_ROOM")) -}} #!/usr/bin/env bash +# @file Netdata +# @brief Connects Netdata with Netdata's free cloud dashboard and applies some system optimizations, if necessary +# @description +# This script connects Netdata with Netdata Cloud if Netdata is installed, the `NETDATA_TOKEN` is provided, and the +# `NETDATA_ROOM` is defined. This allows you to graphically browse through system metrics on all your connected devices +# from a single free web application. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.sh.tmpl similarity index 81% rename from home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.sh.tmpl index 36168eba..48243b26 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_59-connect-tailscale.sh.tmpl @@ -1,5 +1,10 @@ {{- if or (and (ne .host.distro.family "windows") (stat (joinPath .host.home ".config" "age" "chezmoi.txt")) (stat (joinPath .chezmoi.sourceDir ".chezmoitemplates" "secrets" "TAILSCALE_AUTH_KEY")) (env "TAILSCALE_AUTH_KEY")) -}} #!/usr/bin/env bash +# @file Tailscale +# @brief Connects the Tailscale client with the Tailscale network +# @description +# This script ensures the `tailscaled` system daemon is installed on macOS. Then, on both macOS and Linux, it connects to the Tailscale +# network if the `TAILSCALE_AUTH_KEY` variable is provided. ### Install the Tailscale system daemon if [ -d /Applications ] && [ -d System ]; then diff --git a/home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.sh.tmpl similarity index 95% rename from home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.sh.tmpl index 0a5d538c..e6b91cc5 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_61-plymouth-settings.sh.tmpl @@ -1,5 +1,9 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file Plymouth Configuration +# @brief Configures Plymouth to use a custom theme +# @description +# This script installs Plymouth and then configures it to use our custom Betelgeuse theme. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.sh.tmpl similarity index 98% rename from home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.sh.tmpl index b9bb7df3..fb3c126f 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_64-grub-settings.sh.tmpl @@ -1,5 +1,9 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file GRUB2 Theme / Configuration +# @brief Configures GRUB2 to use a custom theme +# @description +# This script configures GRUB2 with a custom theme. {{ includeTemplate "universal/profile" }} {{ includeTemplate "universal/logg" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.sh.tmpl similarity index 97% rename from home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.sh.tmpl index d839aa6f..dc0d6bbb 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_70-misc-bug-fixes.sh.tmpl @@ -1,5 +1,9 @@ {{- if (eq .host.distro.family "linux") -}} #!/usr/bin/env bash +# @file Miscellaneous Bug Fixes +# @brief This script applies miscellaneous bug fixes. +# @description +# This script houses bug fixes that do not yet have their own script file. # enabled extensions: {{ output "dconf" "read" "/org/gnome/shell/enabled-extensions" }} diff --git a/home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.tmpl b/home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.sh.tmpl similarity index 95% rename from home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.tmpl rename to home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.sh.tmpl index 176649e0..8a7129f5 100644 --- a/home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.tmpl +++ b/home/.chezmoiscripts/universal/run_onchange_after_80-bash-completions.sh.tmpl @@ -1,5 +1,10 @@ {{- if (ne .host.distro.family "windows") -}} #!/usr/bin/env bash +# @file Bash Completions +# @brief Ensures bash completions are pre-generated and made available +# @description +# This script detects the presence of various executables with Bash completions available and then +# conditionally adds the completions to the Bash completions folder. # .chezmoidata.yml hash: {{ include (joinPath .chezmoi.sourceDir ".chezmoidata.yaml")| sha256sum }} # software.yml hash: {{ include (joinPath .chezmoi.homeDir ".local" "share" "chezmoi" "software.yml")| sha256sum }} diff --git a/home/dot_config/rclone/system/s3-docker.service.tmpl b/home/dot_config/rclone/system/s3-docker.service.tmpl deleted file mode 100644 index d6efc0d7..00000000 --- a/home/dot_config/rclone/system/s3-docker.service.tmpl +++ /dev/null @@ -1,14 +0,0 @@ -[Unit] -Description=rclone S3 service (docker) -After=network-online.target - -[Service] -Type=simple -User=rclone -ExecStart=/usr/local/bin/rclone-mount "rclone" "rclone" "s3-docker" -ExecStop=/bin/fusermount -u /mnt/s3-docker -Restart=always -RestartSec=10 - -[Install] -WantedBy=default.target