Add basic auth and settings

Author: bencroker

src/config.php

@@ -60,6 +60,9 @@
         // Restrict access to the front-end to the following IP addresses (logged in admins always have access).
         //'restrictFrontEndIpAddresses' =>  = [],
 
+        // Whether to use basic authentication when accessing the site.
+        //'basicAuthEnabled' => false,
+
         // A username to use for basic authentication when accessing the site.
         //'basicAuthUsername' => '',
 

src/models/SettingsModel.php

@@ -70,6 +70,11 @@ class SettingsModel extends Model
      */
     public array|string $restrictFrontEndIpAddresses = [];
 
+    /**
+     * @var bool
+     */
+    public bool $basicAuthEnabled = false;
+
     /**
      * @var string
      */

src/services/TestsService.php

@@ -141,7 +141,7 @@ public function beforeRunTests(): void
         }
 
         $config = ['timeout' => 10];
-        if (!Sherlock::$plugin->getIsLite() && Sherlock::$plugin->settings->basicAuthUsername) {
+        if (!Sherlock::$plugin->getIsLite() && Sherlock::$plugin->settings->basicAuthEnabled) {
             $config['auth'] = [
                 Sherlock::$plugin->settings->basicAuthUsername,
                 Sherlock::$plugin->settings->basicAuthPassword,

src/templates/_settings.twig

@@ -284,30 +284,42 @@
             {{ not isLite ? '<hr>' }}
 
             {% set fields %}
-                <h1>{{ 'Basic Auth'|t('sherlock') }}</h1>
-                {{ forms.autosuggestField({
-                    label: 'Username'|t('sherlock'),
-                    name: (isLite ? '' : 'basicAuthUsername'),
-                    instructions: 'A username to use for basic authentication when accessing the site.'|t('sherlock'),
-                    suggestEnvVars: true,
-                    suggestions: craft.cp.getEnvSuggestions(),
-                    warning: (config.basicAuthUsername is defined ? configWarning('basicAuthUsername')),
-                    value: (isLite ? '' : settings.basicAuthUsername),
-                    errors: settings.getErrors('basicAuthUsername'),
-                    disabled: readOnly,
-                }) }}
-                {{ forms.autosuggestField({
-                    type: 'password',
-                    label: 'Password'|t('sherlock'),
-                    name: (isLite ? '' : 'basicAuthPassword'),
-                    instructions: 'A password to use for basic authentication when accessing the site.'|t('sherlock'),
+                {{ forms.lightswitchField({
+                    label: 'Basic Auth'|t('sherlock'),
+                    name: (isLite ? '' : 'basicAuthEnabled'),
+                    instructions: 'Whether to enable basic authentication when accessing the site.'|t('sherlock'),
                     suggestEnvVars: true,
                     suggestions: craft.cp.getEnvSuggestions(),
-                    warning: (config.basicAuthPassword is defined ? configWarning('basicAuthPassword')),
-                    value: (isLite ? '' : settings.basicAuthPassword),
-                    errors: settings.getErrors('basicAuthPassword'),
+                    warning: (config.basicAuthEnabled is defined ? configWarning('basicAuthEnabled')),
+                    value: (isLite ? '' : settings.basicAuthEnabled),
+                    errors: settings.getErrors('basicAuthEnabled'),
                     disabled: readOnly,
+                    toggle: 'basicAuth',
                 }) }}
+                <div id="basicAuth" class="hidden">
+                    {{ forms.autosuggestField({
+                        label: 'Username'|t('sherlock'),
+                        name: (isLite ? '' : 'basicAuthUsername'),
+                        instructions: 'A username to use for basic authentication when accessing the site.'|t('sherlock'),
+                        suggestEnvVars: true,
+                        suggestions: craft.cp.getEnvSuggestions(),
+                        warning: (config.basicAuthUsername is defined ? configWarning('basicAuthUsername')),
+                        value: (isLite ? '' : settings.basicAuthUsername),
+                        errors: settings.getErrors('basicAuthUsername'),
+                        disabled: readOnly,
+                    }) }}
+                    {{ forms.autosuggestField({
+                        label: 'Password'|t('sherlock'),
+                        name: (isLite ? '' : 'basicAuthPassword'),
+                        instructions: 'A password to use for basic authentication when accessing the site.'|t('sherlock'),
+                        suggestEnvVars: true,
+                        suggestions: craft.cp.getEnvSuggestions(),
+                        warning: (config.basicAuthPassword is defined ? configWarning('basicAuthPassword')),
+                        value: (isLite ? '' : settings.basicAuthPassword),
+                        errors: settings.getErrors('basicAuthPassword'),
+                        disabled: readOnly,
+                    }) }}
+                </div>
             {% endset %}
 
             {% include 'sherlock/_includes/paidFields' %}