server: hide systemd stuff behind compiletime cond

.gitea/workflows/build-and-test.yml

@@ -6,6 +6,9 @@ on:
       - main
   pull_request:
 
+env:
+  BINSTALL_DISABLE_TELEMETRY: 'true'
+
 jobs:
   build:
     runs-on: debian-latest
@@ -13,10 +16,7 @@ jobs:
       - uses: actions/checkout@v6
 
       - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            override: true
+        uses: dtolnay/rust-toolchain@stable
 
       - name: Build
         run: cargo build --all-features --verbose --release
@@ -27,10 +27,8 @@ jobs:
       - uses: actions/checkout@v6
 
       - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@stable
         with:
-            toolchain: stable
-            override: true
             components: rustfmt, clippy
 
       - name: Check code format
@@ -43,15 +41,13 @@ jobs:
     runs-on: debian-latest
     steps:
       - uses: actions/checkout@v6
+      - uses: cargo-bins/cargo-binstall@main
 
       - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            override: true
+        uses: dtolnay/rust-toolchain@stable
 
       - name: Install cargo-deny
-        run: cargo install cargo-deny
+        run: cargo binstall -y cargo-deny
 
       - name: Check licenses
         run: |
@@ -72,8 +68,7 @@ jobs:
         run: cargo binstall -y cargo-nextest --secure
 
       - name: Run tests
-        run: |
-          cargo nextest run --release --no-fail-fast
+        run: cargo nextest run --release --no-fail-fast
         env:
           RUST_LOG: "trace"
           RUSTFLAGS: "-Cinstrument-coverage"
@@ -116,10 +111,7 @@ jobs:
       - uses: actions/checkout@v6
 
       - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
-        with:
-            toolchain: stable
-            override: true
+        uses: dtolnay/rust-toolchain@stable
 
       - name: Build docs
         run: cargo doc --all-features --document-private-items --release

.gitea/workflows/publish-deb.yml

@@ -22,6 +22,9 @@ on:
           - beta
         default: stable
 
+env:
+  BINSTALL_DISABLE_TELEMETRY: 'true'
+
 # TODO: dynamic matrix builds when...
 #       https://github.com/go-gitea/gitea/issues/25179
 jobs:
@@ -33,15 +36,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v6
+      - uses: cargo-bins/cargo-binstall@main
 
       - name: Install rust toolchain
-        uses: actions-rs/toolchain@v1
+        uses: dtolnay/rust-toolchain@master
         with:
             toolchain: ${{ inputs.rust_toolchain }}
-            override: true
 
       - name: Install cargo-deb
-        run: cargo install cargo-deb
+        run: cargo binstall -y cargo-deb
 
       - name: Build deb package
         env:
@@ -60,7 +63,7 @@ jobs:
       - name: Upload deb package artifact
         uses: actions/upload-artifact@v3
         with:
-          name: muscl-deb-${{ matrix.os }}.zip
+          name: muscl-deb-${{ matrix.os }}-${{ gitea.sha }}.zip
           path: target/debian/*.deb
           if-no-files-found: error
           retention-days: 30

Cargo.toml

@@ -34,7 +34,6 @@ nix = { version = "0.30.1", features = ["fs", "process", "socket", "user"] }
 num_cpus = "1.17.0"
 prettytable = "0.10.0"
 rand = "0.9.2"
-sd-notify = "0.4.5"
 serde = "1.0.228"
 serde_json = { version = "1.0.145", features = ["preserve_order"] }
 sqlx = { version = "0.8.6", features = ["runtime-tokio", "mysql", "tls-rustls"] }
@@ -45,12 +44,13 @@ tokio-stream = "0.1.17"
 tokio-util = { version = "0.7.17", features = ["codec", "rt"] }
 toml = "0.9.8"
 tracing = { version = "0.1.43", features = ["log"] }
-tracing-journald = "0.3.2"
 tracing-subscriber = "0.3.22"
 uuid = { version = "1.19.0", features = ["v4"] }
 
 [target.'cfg(target_os = "linux")'.dependencies]
 landlock = "0.4.4"
+sd-notify = "0.4.5"
+tracing-journald = "0.3.2"
 
 [build-dependencies]
 anyhow = "1.0.100"
@@ -147,6 +147,16 @@ assets = [
         "usr/share/fish/vendor_completions.d/",
         "644",
     ],
+    [
+      "README.md",
+      "usr/share/doc/muscl/",
+      "644",
+    ],
+    [
+      "docs/*.md",
+      "usr/share/doc/muscl/docs/",
+      "644",
+    ],
 ]
 preserve-symlinks = true
 maintainer-scripts = "debian/"

assets/debian/config.toml

@@ -16,7 +16,8 @@ port = 3306
 # systemd unit.
 username = "muscl"
 # This file gets created by systemd automatically, given you have set
-# the password with `systemd-creds`.
+# the password with `systemd-creds`. See /usr/share/doc/muscl/docs/installation.md
+# for more information.
 password_file = "/run/credentials/muscl.service/muscl_mysql_password"
 
 # Database connection timeout in seconds

src/server/command.rs

@@ -16,6 +16,7 @@ pub struct ServerArgs {
     pub subcmd: ServerCommand,
 
     /// Enable systemd mode
+    #[cfg(target_os = "linux")]
     #[arg(long)]
     pub systemd: bool,
 
@@ -58,6 +59,8 @@ pub async fn handle_command(
     args: ServerArgs,
 ) -> anyhow::Result<()> {
     let mut auto_detected_systemd_mode = false;
+
+    #[cfg(target_os = "linux")]
     let systemd_mode = args.systemd || {
         if let Ok(true) = sd_notify::booted() {
             auto_detected_systemd_mode = true;
@@ -67,24 +70,30 @@ pub async fn handle_command(
         }
     };
 
+    #[cfg(not(target_os = "linux"))]
+    let systemd_mode = false;
+
     if systemd_mode {
-        let subscriber = tracing_subscriber::Registry::default()
-            .with(verbosity.tracing_level_filter())
-            .with(tracing_journald::layer()?);
+        #[cfg(target_os = "linux")]
+        {
+            let subscriber = tracing_subscriber::Registry::default()
+                .with(verbosity.tracing_level_filter())
+                .with(tracing_journald::layer()?);
 
-        tracing::subscriber::set_global_default(subscriber)
-            .context("Failed to set global default tracing subscriber")?;
+            tracing::subscriber::set_global_default(subscriber)
+                .context("Failed to set global default tracing subscriber")?;
 
-        trace_server_prelude();
+            trace_server_prelude();
 
-        if verbosity.tracing_level_filter() >= tracing::Level::TRACE {
-            tracing::warn!("{}", LOG_LEVEL_WARNING.trim());
-        }
+            if verbosity.tracing_level_filter() >= tracing::Level::TRACE {
+                tracing::warn!("{}", LOG_LEVEL_WARNING.trim());
+            }
 
-        if auto_detected_systemd_mode {
-            tracing::debug!("Running in systemd mode, auto-detected");
-        } else {
-            tracing::debug!("Running in systemd mode");
+            if auto_detected_systemd_mode {
+                tracing::debug!("Running in systemd mode, auto-detected");
+            } else {
+                tracing::debug!("Running in systemd mode");
+            }
         }
     } else {
         let subscriber = tracing_subscriber::Registry::default()

src/server/supervisor.rs

@@ -68,6 +68,7 @@ impl Supervisor {
 
         let mut watchdog_duration = None;
         let mut watchdog_micro_seconds = 0;
+        #[cfg(target_os = "linux")]
         let watchdog_task =
             if systemd_mode && sd_notify::watchdog_enabled(true, &mut watchdog_micro_seconds) {
                 watchdog_duration = Some(Duration::from_micros(watchdog_micro_seconds));
@@ -80,6 +81,8 @@ impl Supervisor {
                 tracing::debug!("Systemd watchdog not enabled, skipping watchdog thread");
                 None
             };
+        #[cfg(not(target_os = "linux"))]
+        let watchdog_task = None;
 
         let db_connection_pool =
             Arc::new(RwLock::new(create_db_connection_pool(&config.mysql).await?));
@@ -102,19 +105,34 @@ impl Supervisor {
 
         let task_tracker = TaskTracker::new();
 
+        #[cfg(target_os = "linux")]
         let status_notifier_task = if systemd_mode {
             Some(spawn_status_notifier_task(task_tracker.clone()))
         } else {
             None
         };
+        #[cfg(not(target_os = "linux"))]
+        let status_notifier_task = None;
 
         let (tx, rx) = broadcast::channel(1);
 
         // TODO: try to detech systemd socket before using the provided socket path
+        #[cfg(target_os = "linux")]
         let listener = Arc::new(RwLock::new(match config.socket_path {
             Some(ref path) => create_unix_listener_with_socket_path(path.clone()).await?,
             None => create_unix_listener_with_systemd_socket().await?,
         }));
+        #[cfg(not(target_os = "linux"))]
+        let listener = Arc::new(RwLock::new(
+            create_unix_listener_with_socket_path(
+                config
+                    .socket_path
+                    .as_ref()
+                    .ok_or(anyhow!("Socket path must be set"))?
+                    .clone(),
+            )
+            .await?,
+        ));
 
         let (reload_tx, reload_rx) = broadcast::channel(1);
         let shutdown_cancel_token = CancellationToken::new();
@@ -211,16 +229,28 @@ impl Supervisor {
     //       first. Make sure to handle that appropriately to avoid a deadlock.
     async fn reload_listener(&self) -> anyhow::Result<()> {
         let config = self.config.lock().await;
+        #[cfg(target_os = "linux")]
         let new_listener = match config.socket_path {
             Some(ref path) => create_unix_listener_with_socket_path(path.clone()).await?,
             None => create_unix_listener_with_systemd_socket().await?,
         };
+        #[cfg(not(target_os = "linux"))]
+        let new_listener = create_unix_listener_with_socket_path(
+            config
+                .socket_path
+                .as_ref()
+                .ok_or(anyhow!("Socket path must be set"))?
+                .clone(),
+        )
+        .await?;
+
         let mut listener = self.listener.write().await;
         *listener = new_listener;
         Ok(())
     }
 
     pub async fn reload(&self) -> anyhow::Result<()> {
+        #[cfg(target_os = "linux")]
         sd_notify::notify(false, &[sd_notify::NotifyState::Reloading])?;
 
         let previous_config = self.config.lock().await.clone();
@@ -257,12 +287,14 @@ impl Supervisor {
             self.resume_receiving_new_connections()?;
         }
 
+        #[cfg(target_os = "linux")]
         sd_notify::notify(false, &[sd_notify::NotifyState::Ready])?;
 
         Ok(())
     }
 
     pub async fn shutdown(&self) -> anyhow::Result<()> {
+        #[cfg(target_os = "linux")]
         sd_notify::notify(false, &[sd_notify::NotifyState::Stopping])?;
 
         tracing::debug!("Stop accepting new connections");
@@ -323,6 +355,7 @@ impl Supervisor {
     }
 }
 
+#[cfg(target_os = "linux")]
 fn spawn_watchdog_task(duration: Duration) -> JoinHandle<()> {
     tokio::spawn(async move {
         let mut interval = interval(duration.div_f32(2.0));
@@ -339,6 +372,7 @@ fn spawn_watchdog_task(duration: Duration) -> JoinHandle<()> {
     })
 }
 
+#[cfg(target_os = "linux")]
 fn spawn_status_notifier_task(task_tracker: TaskTracker) -> JoinHandle<()> {
     const STATUS_UPDATE_INTERVAL_SECS: Duration = Duration::from_secs(1);
 
@@ -385,6 +419,7 @@ async fn create_unix_listener_with_socket_path(
     Ok(listener)
 }
 
+#[cfg(target_os = "linux")]
 async fn create_unix_listener_with_systemd_socket() -> anyhow::Result<TokioUnixListener> {
     let fd = sd_notify::listen_fds()
         .context("Failed to get file descriptors from systemd")?
@@ -468,6 +503,7 @@ async fn listener_task(
     mut supervisor_message_receiver: broadcast::Receiver<SupervisorMessage>,
     db_is_mariadb: Arc<RwLock<bool>>,
 ) -> anyhow::Result<()> {
+    #[cfg(target_os = "linux")]
     sd_notify::notify(false, &[sd_notify::NotifyState::Ready])?;
 
     loop {