Merge pull request #4116 from AllskyTeam/master

merge master changes into this branch

.github/ISSUE_TEMPLATE/2-bug_report.yml

@@ -53,20 +53,20 @@ body:
         \*  Include a clear and concise description of what the problem is.
         \*  Include a screenshot of any error message(s).
         \*  Can you reproduce it?  If so, how?
-        \*  Did any settings or anything else change?
     validations:
       required: true
   - type: textarea
     id: logs
     attributes:
-      label: Log / configuration files
+      label: Log and configuration files (ATTACH files, do NOT copy/paste them)
       description: |
-        ATTACH files, do NOT copy/paste them:
+        If the problem occured during installation, attach:
+          \*  `~/allsky/config/logs/install.log`
          
-        Follow the instructions for "Reporting Issues" in the Wiki, then attach `/var/log/allsky.log`.
+        Follow the instructions for "Reporting Issues" in the Allsky Documentation, then attach `/var/log/allsky.log`.
          
         Attach `~/allsky/config/settings.json`, appending `.txt` to its name first.
          
         If your problem is with an **Allsky Website**, also attach:
           \*  `~/allsky/html/allsky/configuration.json` (local Website)
-          \*  `~/allsky/config/remote_configuration.json` (remote Website)
+          \*  `~/allsky/config/remote_configuration.json` (remote Website)

.github/workflows/ci_shellcheck.yml

@@ -7,8 +7,8 @@ on:
   push:
     paths:
       - '*.sh'
-      - '*/*.sh'
-      - '*/*/*.sh'
+      - 'scripts/*.sh'
+      - 'scripts/utilities/*.sh'
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
@@ -17,17 +17,17 @@ jobs:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
-    # Steps represent a sequence of tasks that will be executed as part of the job
+    # "steps" represent a sequence of tasks that will be executed as part of the job
     steps:
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      # Runs a set of commands using the runners shell
+      # Runs a set of commands using the runner's shell
       - name: check bash files
         run: |
-          # check bash files (bash -n, shellchecki -x)
+          # check bash files (bash -n, shellcheck -x)
           err=0
-          for i in $(find . -maxdepth 2 -name '*.sh'); do
+          for i in $(find . -maxdepth 3 -name '*.sh'); do
             echo "==================== $i"
             bash -n $i
             if [ $? -ne 0 ]; then
@@ -58,8 +58,9 @@ jobs:
                 #SC2069: Something about the order of >&2 and > xxx
                 #SC2024: similar to SC2069
                 #SC2269: This variable is assigned to itself
+                #SC2317: Command appears to be unreachable
                 ###shellcheck -x -e SC1090 -e SC1091 -e SC2004 -e SC2155 -e SC2181 -e SC2188 -e SC2024 -e SC2069 -e SC2269 $i || this_err=1
-                shellcheck -x -e SC2004 -e SC2155 -e SC2181 -e SC2188 -e SC2024 -e SC2069 -e SC2269 $i || this_err=1
+                shellcheck -x -e SC2004 -e SC2155 -e SC2181 -e SC2188 -e SC2024 -e SC2069 -e SC2269 -e SC2317 $i || this_err=1
                 ;;
             esac
             if [ ${this_err} -eq 1 ]; then

README.md

@@ -43,7 +43,7 @@ In order to run the Allsky software you need:
 
 <!-- HIDE FOR NOW - THE VIDEO IS A COUPLE RELEASES OLD
 PatriotAstro created a great [video](https://www.youtube.com/watch?v=7TGpGz5SeVI) describing the installation steps below.
-__We recommend viewing it before installing the software__, but note that as of March 2024 the video is out of date.
+__We recommend viewing it before installing the software__.
 -->
 
 See the [detailed installation instructions](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/installations/Allsky.html).
@@ -79,7 +79,7 @@ It should be used before requesting support on GitHub.
 <!-- =============================================================================== --> 
 ## Allsky Website and remote server
 
-The local Allsky Website (i.e., on the Pi) in installed with Allsky but must be enabled in the WebUI in order to use it.
+The local Allsky Website (i.e., on the Pi) is installed with Allsky but must be enabled in the WebUI in order to use it.
 You can also install the Allsky Website on a remote server so it can be viewable via the Internet.
 
 See [Installation / Upgrading --> Website](https://htmlpreview.github.io/?https://raw.githubusercontent.com/AllskyTeam/allsky/master/html/documentation/installations/AllskyWebsite.html) for information on how to install and configure an Allsky Website.
@@ -208,4 +208,3 @@ for a list of changes in this release and all prior releases.
 If you found this project useful, here's a link to send Thomas a cup of coffee :)
 
 [![](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=MEBU2KN75G2NG&source=url)
-

config_repo/options.json.repo

@@ -756,7 +756,7 @@
 "name" : "determinefocus",
 "default" : false,
 "description" : "Enable to have the image focus determined and output via the 'FOCUS' variable.",
-"label" : "Focus Mode",
+"label" : "Record Focus",
 "type" : "boolean",
 "usage" : "capture",
 "action" : "stop"

html/allsky/viewSettings.php

@@ -9,6 +9,9 @@
 		echo "<div class='errorMsgBox errorMsgBig'>";
 		echo "This Allsky Website is not fully configured so its settings cannot be displayed.";
 		echo "<br>It is missing the '$settingsScript' file.";
+		echo "<br><br>";
+		echo "To fix: make sure the Website is enabled in the <b>Websites and Remote Server Settings</b>";
+		echo "section of the WebUI's <b>Allsky Settings</b> page.";
 		echo "</div>";
 		exit(1);
 	}

html/documentation/changeLog.html

@@ -123,11 +123,11 @@ <h4>Enhancements / Changes</h4>
 					<span class="WebUISetting">Image Directory</span> in the WebUI.
 				</li>
 				<li>Installing a Website on a remote server is significantly easier as well.
-					Use the new <code>remote_website_install.sh</code> command;
+					Use the new <code>remoteWebsiteInstall.sh</code> command;
 					it will upload the Allsky Website files for you and remove any
 					old, unneeded files.
 					If this is a new remote Website,
-					<code>remote_website_install.sh</code> will ask you whether or not to
+					<code>remoteWebsiteInstall.sh</code> will ask you whether or not to
 					also upload any startrails, keograms, and timelapse videos on your Pi.
 				</li>
 				<li>Images, timelapse, keograms, and startrails can now be written
@@ -322,10 +322,6 @@ <h4>Deleted Settings</h4>
 					was deleted.  It brightened every pixel by the amount specified
 					and is not needed with allsky cameras.
 				</li>
-				<li>The new <span class="WebUISetting">Nighttime Capture</span> and
-					<span class="WebUISetting">Nighttime Save</span> settings
-					are the same as the daytime versions, except for nighttime.
-				</li>
 			</ul>
 
 			<h4>Bug Fixes</h4>
@@ -1201,4 +1197,4 @@ <h2>0.1</h2>
 </body>
 
 </html>
-<script> includeHTML(); </script>
+<script> includeHTML(); </script>

html/documentation/css/custom.css

@@ -269,6 +269,12 @@ body.dark {
 	vertical-align: top;
 }
 
+.noChanges {
+	font-weight: bold;
+	font-size: 110%;
+	padding: 5px 0 5px 2px;
+}
+
 .alert {
 	padding: 5px;
 	margin-bottom: 3px;

html/documentation/explanations/imageSDcard.html

@@ -44,40 +44,49 @@ <h2>1. Re-image an SD card but keep some files</h2>
 but keep your Allsky files.
 </p>
 <p>
-If you have <strong>two SD cards</strong>, the process is straightforward:
-<ol class="minimalPadding">
-	<li>Image the second SD card using the
-		<a href="#install">instructions below.</a>
-	<li>Plug the newly-imaged SD card into your Pi and turn it on.
-	<li>Using an SD card-to-USB adapter, plug it into a USB port on your Pi
-		and copy whatever files you want from it to the main SD card.
-		<blockquote>
-		Copy the <span class="fileName">~/allsky</span> directory on the saved SD card
-		to <span class="fileName">~/allsky-OLD</span> on the main SD card.
-		</blockquote>
-</ol>
-</p>
-<p>
-If you only have <strong>one SD card</strong>, consider getting another one
-and use the instructions above.
-It's always good to have a spare SD card anyway in case the first one goes bad.
-<br>If you can't obtain a second card, do the following:
-<ol class="minimalPadding">
-	<li>Copy <span class="fileName">~/allsky</span> plus any other
-		files, images, etc. you want to keep from your SD card to a
-		USB drive, PC, Mac, or another device.
-	<li>Image the SD card using the
-		<a href="#install">instructions below.</a>
-	<li>Plug the newly-imaged SD card into your Pi and turn it on.
-	<li>Restore your files to the SD card.
-		<blockquote>
-		Copy the saved <span class="fileName">~/allsky</span> directory to
-		<span class="fileName">~/allsky-OLD</span> on the new SD card.
-		</blockquote>
-	<li><a href="../installations/allsky.html" external="true">Install Allsky</a>
-		and tell the installation you want to use the prior version of Allsky;
-		it will then restore your saved images, darks, and configuration files.
+<ol style="list-style-type:upper-alpha">
+<li>If you have <strong>two SD cards</strong>, the process is straightforward:
+	<ol class="minimalPadding">
+		<li>Image the second SD card using the
+			<a href="#install">instructions below.</a>
+		<li>Plug the newly-imaged SD card into your Pi and turn it on.
+		<li>Using an SD card-to-USB adapter, plug it into a USB port on your Pi and
+			copy the <span class="fileName">~/allsky</span> directory on the saved SD card
+			to <span class="fileName">~/allsky-OLD</span> on the new SD card.
+			<br>If you have modules in the old card's <span class="fileName">/opt/allsky</span>
+			directory, copy that directory to the new SD card using <code>sudo</code>.
+			<br>Copy whatever other files you want from the old SD card to the new one.
+	</ol>
+
+<li> If you only have <strong>one SD card</strong>, consider getting another one
+	and use the instructions above.
+	It's always good to have a spare SD card anyway in case the first one goes bad.
+	<br>If you can't obtain a second card, do the following:
+	<ol class="minimalPadding">
+		<li>Copy <span class="fileName">~/allsky</span> plus any other
+			files, images, etc. you want to keep from your SD card to a
+			USB drive, PC, Mac, or another device.
+			<br>If you have modules in <span class="fileName">/opt/allsky</span>,
+			copy that directory as well.
+			Suggestion: name its backup directory
+			<span class="fileName">opt-allsky</span>,
+		<li>Image the SD card using the
+			<a href="#install">instructions below.</a>
+		<li>Plug the newly-imaged SD card into your Pi and turn it on.
+		<li>Restore your files to the SD card.
+			<br>
+			Copy the saved <span class="fileName">~/allsky</span> directory to
+			<span class="fileName">~/allsky-OLD</span> on the new SD card.
+			<br>If you saved <span class="fileName">/opt/allsky</span>,
+			copy that directory to the new SD card using <code>sudo</code>.
+	</ol>
 </ol>
+Now
+<a allsky="true" external="true" href="../installations/allsky.html">install Allsky</a>
+and tell the installation you want to use the prior version of Allsky;
+it will then restore your saved images, darks, and configuration files.
+You may want to leave your 2nd SD card or USB drive attached to the Pi in case you
+missed some files.
 </p>
 
 <h2 id="install">2. First install or "starting over"</h2>

html/documentation/explanations/layout.html

@@ -157,7 +157,7 @@
 		You'll normally view the Allsky Documentation via the WebUI's
 		<span class="WebUIWebPage">Documentation</span> link instead of this file.
 
-	<li><span class="lsBlack">remote_website_install.sh</span>
+	<li><span class="lsBlack">remoteWebsiteInstall.sh</span>
 		<br>
 		The program used to prepare an optional remote Allsky Website.
 		This should only be run after viewing the

html/documentation/index.html

@@ -26,8 +26,8 @@
 
 <p>
 This documentation provides information for
-<a ="true" href="installations/.html">installing</a>,
-<a ="true" href="settings/.html">configuring</a>,
+<a allsky="true" href="installations/Allsky.html">installing</a>,
+<a allsky="true" href="settings/allsky.html">configuring</a>,
 and running the Allsky software,
 including describing what various features like
 <a allsky="true" href="overlays/overlays.html">overlays</a>

html/documentation/installations/Allsky.html

@@ -28,15 +28,29 @@
 <p>
 This page describes how to install and upgrade Allsky.
 </p>
-<blockquote>
+<blockquote class="warning">
+Your camera must be connected to the Pi prior to installation.
+<p>
+If you have an RPi camera, run the following to make sure the camera can be seen by Allsky:
+<pre>
+libcamera-still --list-cameras
+</pre>
+If camera number <code>0</code> (the first camera) is in the list, you're good to go.
+<br>
+Note that some non-Raspberry Pi brand cameras may need special software installed and/or operating system
+configuration changes - read the camera manual.
+</p>
+</blockquote>
+
+<p>
 We highly suggest installing the current version of Allsky on a clean SD card
 since a lot of files have changed and using a clean card will ensure a clutter-free environment
 with the most recent commands.
 <br>
 See the instructions on
 <a allsky="true" href="../explanations/imageSDcard.html" external="true">
 how to image an SD card for use by Allsky.</a>
-</blockquote>
+</p>
 
 <h2>If a version of Allsky already exists</h2>
 <details><summary></summary>

html/documentation/installations/AllskyWebsite.html

@@ -98,7 +98,7 @@ <h2>Install a remote Allsky Website</h2>
 			<span class="subSettingsHeader">Remote Website</span> subsection.
 			Make sure to enable <span class="WebUISetting">Use Remote Website</span>
 			as well as enough other settings so Allsky can upload a file to the Website.
-		<li>Run <code>cd ~/allsky;  ./remote_website_install.sh</code>
+		<li>Run <code>cd ~/allsky;  ./remoteWebsiteInstall.sh</code>
 			to upload a default configuration file to your server,
 			leaving the master copy on the Pi.
 			<ul>

html/documentation/installations/RemoteServer.html

@@ -31,6 +31,14 @@
 to accept uploads of the current Allsky image
 as well as startrails, keograms, and timelapse videos.
 </p>
+
+<blockquote class="warning">
+This page is for setting up a <strong>remote server</strong>,
+which typically does not run an Allsky Website.
+If you want to set up a <strong>remote Website</strong>,
+click <a allsky="true" href="Allsky.html">here</a>.
+</blockquote>
+
 <h4>Why use a remote server?</h4>
 <p>
 Since this server does NOT run the Allsky Website software you may wonder
@@ -62,7 +70,7 @@ <h4>Preparing the remote server</h4>
 		of the WebUI's <span class="WebUIWebPage">Allsky Settings</span> page
 		and fill in the settings.
 		See the
-		<a allsky="true" external="true" href="../settings/allsky.html#remoteServerSettings">
+		<a allsky="true" external="true" href="../settings/allsky.html#remoteserver">
 		Allsky Settings</a> page for a description of the settings.
 </ol>
 </p>

html/documentation/knownIssues.html

@@ -44,7 +44,7 @@ <h4>Image Capture</h4>
 		RPi cameras don't support sensor temperature.
 
 		<br><span class="wa">Workaround</span>:
-			See <a allsky="true" href="changeLog.html#sensorTemperature">this workaround</a>.
+			See <a allsky="true" href="/documentation/changeLog.html#sensorTemperature">this workaround</a>.
 
 		<br><span class="fp">Future Plans</span>:
 		Will fix in the next major release for users running the Bullseye or Bookworm operating systems.

html/documentation/settings/allsky.html

@@ -416,6 +416,11 @@
 	<td>No flip</td>
 	<td>How to flip the image (No flip, Horizontal, Vertical, or Both).</td>
 </tr>
+
+<tr><td id="determinefocus"><span class="WebUISetting">Record Focus</span></td>
+	<td>No</td>
+	<td>Enable to have the overall focus of the image determined and output via the 'FOCUS' variable, which can then be used in an overlay.</td>
+</tr>
 <tr><td id="consistentdelays"><span class="WebUISetting">Consistent Delays Between Images</span></td>
 	<td>Yes</td>
 	<td>Enable this to force the time between the start of exposures to be a consistent length

html/documentation/settings/allskyWebsite.html

@@ -747,4 +747,3 @@ <h3><span class="settings editorSetting">homePage</span> settings</h3>
 </body>
 </html>
 <script> includeHTML(); </script>
-

html/documentation/troubleshooting/other.html

@@ -154,4 +154,3 @@ <h2>Images are corrupted</h2>
 </body>
 </html>
 <script> includeHTML(); </script>
-

html/includes/allskySettings.php

@@ -504,8 +504,8 @@ function DisplayAllskyConfig() {
 
 			if ($ok) {
 				if (! $changesMade && ! $fromConfiguration) {
-					$msg = "No settings changed.  Nothing updated.";
-					$status->addMessage($msg, 'warning');
+					$msg = "<div class='noChanges'>No settings changed.  Nothing updated.</div>";
+					$status->addMessage($msg, 'message');
 					$msg = "";
 				} else if ($changes !== "") {
 					$moreArgs = "";

html/includes/datautil.php

@@ -3,7 +3,6 @@
 include_once('functions.php');
 initialize_variables();		// sets some variables
 
-include_once('raspap.php');
 include_once('authenticate.php');
 
 class DATAUTIL