systemd unit files support

spencerwooo · Dec 4, 2023 · ffbb310 · ffbb310
1 parent a5956c7
commit ffbb310
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 4 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "bitsrun"
 description = "A headless login and logout CLI for 10.0.0.55 at BIT"
-version = "0.3.0"
+version = "0.3.1"
 edition = "2021"
 license = "MIT"
 homepage = "https://github.com/spencerwooo/bitsrun-rs"
@@ -43,3 +43,4 @@ strip = "symbols"
 
 [package.metadata.deb]
 copyright = "2023 Spencer Woo"
+maintainer-scripts = "debian/"
diff --git a/README.md b/README.md
@@ -5,7 +5,7 @@
 [![GitHub release (with filter)](https://img.shields.io/github/v/release/spencerwooo/bitsrun-rs)](https://github.com/spencerwooo/bitsrun-rs/releases/latest)
 [![Crates.io](https://img.shields.io/crates/v/bitsrun?color=rgb(221%2C%20170%2C%2071))](https://crates.io/crates/bitsrun)
 
-🌐 A headless login and logout CLI app for 10.0.0.55 at BIT, now in Rust.
+🌐 A headless login and logout CLI for 10.0.0.55 at BIT, now in Rust.
 
 ![screenshot](https://github.com/spencerwooo/bitsrun-rs/assets/32114380/011e7591-1474-4df8-a371-7a9da7629959)
 
@@ -15,10 +15,11 @@
 
 - `curl -fsSL https://cdn.jsdelivr.net/gh/spencerwooo/bitsrun-rs@main/install.sh | sh -`
 
-#### Ubuntu / Debian
+#### Ubuntu / Debian (recommended for `systemd` support)
 
 - Download the latest `.deb` package from [Releases](https://github.com/spencerwooo/bitsrun-rs/releases/latest).
-- `sudo dpkg -i <file>.deb`
+- `sudo apt install ./<path/to/file>.deb`
+- Start `[email protected]` if desired: `sudo systemctl start bitsrun`
 
 #### Cargo
 
@@ -54,6 +55,19 @@ bitsrun: <ip> (<username>) is online
 └────────────────┴───────────────┴───────────────┴─────────┘
 ```
 
+To keep the session alive, use `bitsrun keep-alive`:
+
+```console
+$ bitsrun keep-alive
+ INFO  bitsrun::daemon > starting daemon (<username>) with polling interval=3600s
+ INFO  bitsrun::daemon > <ip> (<username>): login success,
+ ...
+ ^C INFO  bitsrun::daemon > <username>: gracefully exiting
+```
+
+> [!NOTE]
+> Use available system service managers to run `bitsrun keep-alive` as a daemon. (e.g., `systemd` for Linux, `launchd` for macOS, and Windows Service for Windows).
+
 ## Available commands
 
 ```console

diff --git a/debian/[email protected] b/debian/[email protected]
@@ -0,0 +1,12 @@
+[Unit]
+Description=A headless login and logout CLI for 10.0.0.55 at BIT (%i).
+After=network.target
+
+[Service]
+Type=simple
+User=%i
+Restart=on-abort
+ExecStart=/usr/bin/bitsrun keep-alive
+
+[Install]
+WantedBy=multi-user.target