feat: release check mode (#4095)

assets/components/Announcements.vue

@@ -1,5 +1,9 @@
 <template>
-  <Dropdown class="dropdown-end" @closed="releaseSeen = mostRecent?.tag ?? config.version">
+  <Dropdown
+    class="dropdown-end"
+    @click="config.releaseCheckMode === 'manual' && fetchReleases()"
+    @closed="releaseSeen = mostRecent?.tag ?? config.version"
+  >
     <template #trigger>
       <mdi:announcement class="size-6 -rotate-12" />
       <template v-if="announcements.length > 0 && releaseSeen != mostRecent?.tag">
@@ -63,7 +67,7 @@
 <script setup lang="ts">
 import { useAnnouncements } from "@/stores/announcements";
 
-const { announcements, mostRecent } = useAnnouncements();
+const { announcements, mostRecent, fetchReleases } = useAnnouncements();
 const { t } = useI18n();
 
 const releaseSeen = useProfileStorage("releaseSeen", config.version);

assets/stores/announcements.ts

@@ -12,7 +12,25 @@ type Announcement = {
   breaking: number;
 };
 
-const { data: releases } = useFetch(withBase("/api/releases")).get().json<Announcement[]>();
+const releases = ref<Announcement[]>([]);
+let fetched = false;
+
+async function fetchReleases() {
+  if (fetched) return;
+  fetched = true;
+
+  try {
+    const { data } = await useFetch(withBase("/api/releases")).get().json<Announcement[]>();
+    releases.value = data.value || [];
+  } catch (error) {
+    console.error("Error while fetching releases:\n", error);
+    fetched = false;
+  }
+}
+
+if (config.releaseCheckMode === "automatic") {
+  fetchReleases();
+}
 
 const otherAnnouncements = [] as Announcement[];
 
@@ -33,5 +51,6 @@ export function useAnnouncements() {
     announcements,
     latestRelease,
     hasRelease,
+    fetchReleases,
   };
 }

assets/stores/config.ts

@@ -13,6 +13,7 @@ export interface Config {
   enableActions: boolean;
   enableShell: boolean;
   disableAvatars: boolean;
+  releaseCheckMode: "automatic" | "manual";
   user?: {
     username: string;
     email: string;

docs/guide/supported-env-vars.md

@@ -7,7 +7,7 @@ title: Environment Variables and Subcommands
 Configurations can be done with flags or environment variables. The table below outlines all supported options and their respective env vars.
 
 | Flag                   | Env Variable                | Default        |
-| --------------------- | -------------------------- | -------------- |
+| ---------------------- | --------------------------- | -------------- |
 | `--addr`               | `DOZZLE_ADDR`               | `:8080`        |
 | `--base`               | `DOZZLE_BASE`               | `/`            |
 | `--hostname`           | `DOZZLE_HOSTNAME`           | `""`           |
@@ -22,6 +22,7 @@ Configurations can be done with flags or environment variables. The table below
 | `--filter`             | `DOZZLE_FILTER`             | `""`           |
 | `--no-analytics`       | `DOZZLE_NO_ANALYTICS`       | `false`        |
 | `--mode`               | `DOZZLE_MODE`               | `server`       |
+| `--release-check-mode` | `DOZZLE_RELEASE_CHECK_MODE` | `automatic`    |
 | `--remote-host`        | `DOZZLE_REMOTE_HOST`        |                |
 | `--remote-agent`       | `DOZZLE_REMOTE_AGENT`       |                |
 | `--timeout`            | `DOZZLE_TIMEOUT`            | `10s`          |

internal/support/cli/args.go

@@ -26,6 +26,7 @@ type Args struct {
 	DisableAvatars   bool                `arg:"--disable-avatars,env:DOZZLE_DISABLE_AVATARS" default:"false" help:"disables avatars for authenticated users."`
 	FilterStrings    []string            `arg:"env:DOZZLE_FILTER,--filter,separate" help:"filters docker containers using Docker syntax."`
 	Filter           map[string][]string `arg:"-"`
+	ReleaseCheckMode string              `arg:"--release-check-mode,env:DOZZLE_RELEASE_CHECK_MODE" default:"automatic" help:"sets the release check mode. When manual, releases will not be automatically fetched."`
 	RemoteHost       []string            `arg:"env:DOZZLE_REMOTE_HOST,--remote-host,separate" help:"list of hosts to connect remotely"`
 	RemoteAgent      []string            `arg:"env:DOZZLE_REMOTE_AGENT,--remote-agent,separate" help:"list of agents to connect remotely"`
 	NoAnalytics      bool                `arg:"--no-analytics,env:DOZZLE_NO_ANALYTICS" help:"disables anonymous analytics"`

internal/web/index.go

@@ -52,6 +52,7 @@ func (h *handler) executeTemplate(w http.ResponseWriter, req *http.Request) {
 		config["enableActions"] = h.config.EnableActions
 		config["enableShell"] = h.config.EnableShell
 		config["disableAvatars"] = h.config.DisableAvatars
+		config["releaseCheckMode"] = h.config.ReleaseCheckMode
 	}
 
 	if user != nil {

internal/web/routes.go

@@ -17,6 +17,13 @@ import (
 	"github.com/rs/zerolog/log"
 )
 
+type ReleaseCheckMode string
+
+const (
+	Automatic ReleaseCheckMode = "automatic"
+	Manual    ReleaseCheckMode = "manual"
+)
+
 type AuthProvider string
 
 const (
@@ -37,6 +44,7 @@ type Config struct {
 	EnableActions    bool
 	EnableShell      bool
 	DisableAvatars   bool
+	ReleaseCheckMode ReleaseCheckMode
 	Labels           container.ContainerLabels
 }
 

main.go

@@ -140,6 +140,17 @@ func fileExists(filename string) bool {
 func createServer(args cli.Args, hostService web.HostService) *http.Server {
 	_, dev := os.LookupEnv("DEV")
 
+	var releaseCheckMode web.ReleaseCheckMode = web.Automatic
+
+	switch args.ReleaseCheckMode {
+		case "automatic":
+			releaseCheckMode = web.Automatic
+		case "manual":
+			releaseCheckMode = web.Manual
+		default:
+			log.Fatal().Str("releaseCheckMode", args.ReleaseCheckMode).Msg("Invalid release check mode")
+	}
+
 	var provider web.AuthProvider = web.NONE
 	var authorizer web.Authorizer
 	if args.AuthProvider == "forward-proxy" {
@@ -201,6 +212,7 @@ func createServer(args cli.Args, hostService web.HostService) *http.Server {
 		EnableActions:    args.EnableActions,
 		EnableShell:      args.EnableShell,
 		DisableAvatars:   args.DisableAvatars,
+		ReleaseCheckMode: releaseCheckMode,
 		Labels:           args.Filter,
 	}