Merge pull request #7 from PlqnK/migrate-to-truenas-12

Update scripts to support TrueNAS 12

Author: PlqnK

.markdownlint.yml

@@ -1,2 +1,3 @@
 ---
 MD013: false
+MD024: false

CHANGELOG.md

@@ -6,6 +6,26 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+## [2.0.0] - 2020-11-02
+
+Initial release with support for TrueNAS 12 🎉
+
+### Added
+
+- Add a Markdown Lint job to the Lint action
+- Add a Release action to create a GitHub release on git tags with a changelog
+
+### Changed
+
+- Rename repository to "TrueNAS Useful Scripts"
+- Change GitHub URL to <https://github.com/PlqnK/truenas-useful-scripts>
+- Replace every "FreeNAS" references in the readme and scripts to "TrueNAS" where applicable
+
+### Fixed
+
+- Fix `zpool status` output parsing in the ZPool report script
+- Fix ShellCheck action (follow sourced scripts)
+
 ## [1.0.0] - 2020-11-02
 
 Final release supporting FreeNAS 11.3!
@@ -17,5 +37,6 @@ Final release supporting FreeNAS 11.3!
 - 2 information gathering script (CPU & drives temperature as well as drives identification)
 - A standalone bash function to format emails to be sent by the FreeNAS sendmail program
 
-[Unreleased]: https://github.com/PlqnK/freenas-useful-scripts/compare/v1.0.0...HEAD
-[1.0.0]: https://github.com/PlqnK/freenas-useful-scripts/releases/tag/v1.0.0
+[Unreleased]: https://github.com/PlqnK/truenas-useful-scripts/compare/v2.0.0...HEAD
+[2.0.0]: https://github.com/PlqnK/truenas-useful-scripts/compare/v1.0.0...v2.0.0
+[1.0.0]: https://github.com/PlqnK/truenas-useful-scripts/releases/tag/v1.0.0

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2019, Victor Bouvier-Deleau
+Copyright (c) 2019-2020, Victor Bouvier-Deleau
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,12 +1,12 @@
-# FreeNAS Useful Scripts
+# TrueNAS Useful Scripts
 
 ## Disclaimer
 
-These scripts are based on [FreeNAS forums user Bidule0hm scripts](https://forums.freenas.org/index.php?threads/scripts-to-report-smart-zpool-and-ups-status-hdd-cpu-t%C2%B0-hdd-identification-and-backup-the-config.27365/) which are themselves based on [FreeNAS forums user joeschmuck scripts](https://forums.freenas.org/index.php?threads/set-up-smart-reporting-via-email.6211/) and [FreeNAS forums user titan_rw scripts](https://forums.freenas.org/index.php?threads/set-up-smart-reporting-via-email.6211/). Though I still did a lot of work, like rewriting large parts of them and doing some overall code cleaning.
+These scripts are based on [TrueNAS forums user Bidule0hm scripts](https://www.truenas.com/community/threads/scripts-to-report-smart-zpool-and-ups-status-hdd-cpu-t%C2%B0-hdd-identification-and-backup-the-config.27365/) which are themselves based on [TrueNAS forums user joeschmuck scripts](https://www.truenas.com/community/threads/set-up-smart-reporting-via-email.6211/) and [TrueNAS forums user titan_rw scripts](https://www.truenas.com/community/threads/set-up-smart-reporting-via-email.6211/). Though I still did a lot of work, like rewriting large parts of them and doing some overall code cleaning.
 
 ## About the project
 
-This is a collection of useful scripts for FreeNAS admins that want to have more reporting than just what's included in the OS, display useful information like HDD and CPU temperature easily in a terminal and scripting the backup of the FreeNAS config.
+This is a collection of useful scripts for TrueNAS admins that want to have more reporting than just what's included in the OS, display useful information like HDD and CPU temperature easily in a terminal and scripting the backup of the TrueNAS config.
 
 ## Roadmap
 
@@ -16,13 +16,15 @@ This is a collection of useful scripts for FreeNAS admins that want to have more
 
 ## Prerequisites
 
-- FreeNAS (tested with version 11.2+)
+- TrueNAS 12.0+
+
+> For FreeNAS 11.3 support see the `v1.0.0` release/tag
 
 ## Installation
 
 ```bash
-git clone https://github.com/PlqnK/freenas-useful-scripts.git
-cd freenas-useful-scripts
+git clone https://github.com/PlqnK/truenas-useful-scripts.git
+cd truenas-useful-scripts
 for file in *.example*; do cp $file $(echo $file | sed -e 's/.example//'); done
 ```
 
@@ -34,7 +36,7 @@ Next, set the scripts as executable:
 find . -type f -name "*.sh" -exec chmod +x {} \;
 ```
 
-Finally you will need to create cron jobs in the FreeNAS WebUI in order to execute the reporting and backup script on a schedule. [The FreeNAS documentation explains how to do it.](https://www.ixsystems.com/documentation/freenas/11.2/tasks.html#cron-jobs) The command to execute should be:
+Finally you will need to create cron jobs in the TrueNAS WebUI in order to execute the reporting and backup script on a schedule. [The TrueNAS documentation explains how to do it.](https://www.truenas.com/docs/hub/tasks/scheduled/cron-jobs/) The command to execute should be:
 
 ```sh
 /path/to/the/script.sh

config_backup.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Send a FreeNAS config backup via Email and also store it somewhere in a data pool.
+# Send a TrueNAS config backup via Email and also store it somewhere in a data pool.
 
 readonly SCRIPT_PATH="$(cd "$(dirname "${BASH_SOURCE[0]}")" &>/dev/null && pwd)"
 
@@ -11,7 +11,7 @@ source "${SCRIPT_PATH}/global.conf"
 # shellcheck source=format_email.sh
 source "${SCRIPT_PATH}/format_email.sh"
 
-readonly EMAIL_SUBJECT="FreeNAS $(hostname): Config backup"
+readonly EMAIL_SUBJECT="TrueNAS $(hostname): Config backup"
 readonly EMAIL_BODY="/tmp/config_backup.html"
 readonly TAR_FILE="/tmp/${BACKUP_FILE_NAME}.tar.gz"
 
@@ -22,7 +22,7 @@ if [[ "$(sqlite3 /data/freenas-v1.db "pragma integrity_check;")" == "ok" ]]; the
   (
     # Only specify monospace font to let Email client decide of the rest.
     echo "<pre style=\"font-family:monospace\">"
-    echo "<b>Automatic backup of FreeNAS config succeded!</b>"
+    echo "<b>Automatic backup of TrueNAS config succeded!</b>"
     echo ""
     echo "You will find a compressed archive attached."
     echo ""
@@ -45,7 +45,7 @@ else # Send error message via Email.
   (
     # Only specify monospace font to let Email client decide of the rest.
     echo "<pre style=\"font-family:monospace\">"
-    echo "<b>/!\ Automatic backup of FreeNAS config failed /!\</b>"
+    echo "<b>/!\ Automatic backup of TrueNAS config failed /!\</b>"
     echo ""
     echo "The config file is corrupted, you should correct this problem as soon as possible."
     echo ""

format_email.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 #
-# Bash functions to format an email to be sent by the FreeNAS 'sendmail' program.
-# FreeNAS 'sendmail' uses a "custom" mail sending program, written in Python by the FreeNAS team.
+# Bash functions to format an email to be sent by the TrueNAS 'sendmail' program.
+# TrueNAS 'sendmail' uses a "custom" mail sending program, written in Python by the TrueNAS team.
 # I can't make this program work with the Content-Type 'multipart/alternative'.
 # And you are required to use the Content-Type: multipart/mixed, even when you have no attachment because the program
 # will overwrite your other Content-Type/Transfer-Encoding if it's not set.

global.conf

@@ -11,7 +11,7 @@ readonly UI_WARNING_SYMBOL="?"
 readonly UI_CRITICAL_SYMBOL="!"
 
 # Config backup
-readonly BACKUP_FILE_NAME="$(hostname -s)-FreeNAS-$(uname -r)_$(date "+%Y-%m-%d_%H-%M-%S")"
+readonly BACKUP_FILE_NAME="$(hostname -s)-TrueNAS-$(uname -r)_$(date "+%Y-%m-%d_%H-%M-%S")"
 
 # UPS report
 if [[ $(basename $0) == "ups_report.sh" ]]; then

smart_report.sh

@@ -11,7 +11,7 @@ source "${SCRIPT_PATH}/global.conf"
 # shellcheck source=format_email.sh
 source "${SCRIPT_PATH}/format_email.sh"
 
-readonly EMAIL_SUBJECT="FreeNAS $(hostname): SMART status report"
+readonly EMAIL_SUBJECT="TrueNAS $(hostname): SMART status report"
 readonly EMAIL_BODY="/tmp/smart_report.html"
 
 # Only specify monospace font to let Email client decide of the rest.

ups_report.sh

@@ -11,7 +11,7 @@ source "${SCRIPT_PATH}/global.conf"
 # shellcheck source=format_email.sh
 source "${SCRIPT_PATH}/format_email.sh"
 
-readonly EMAIL_SUBJECT="FreeNAS $(hostname): UPS status report"
+readonly EMAIL_SUBJECT="TrueNAS $(hostname): UPS status report"
 readonly EMAIL_BODY="/tmp/ups_report.html"
 
 # Only specify monospace font to let Email client decide of the rest.

user.example.conf

@@ -1,7 +1,7 @@
 # Config backup
-# If you don't want to store your config backup somewhere on your FreeNAS filesystem you can just leave this variable
+# If you don't want to store your config backup somewhere on your TrueNAS filesystem you can just leave this variable
 # empty like: readonly BACKUP_FILE_PATH=""
-readonly BACKUP_FILE_PATH="/path/to/freenas/db/backup/dir"
+readonly BACKUP_FILE_PATH="/path/to/truenas/db/backup/dir"
 # Change the owner of the file, leave empty ("") if not desired
 readonly BACKUP_FILE_OWNER="myuser"