aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2025-05-23 14:42:03 +0200
committermetamuffin <metamuffin@disroot.org>2025-05-23 14:42:03 +0200
commitedccef5270049ae707b6a27a289adc8ec7f1aa32 (patch)
tree0072f8959ccd1ef44d70f4038d4d55655c9a3a67
parentd8d0978bccd6bac4e6930f56c7cf2fa9cf5364ec (diff)
downloadisda-edccef5270049ae707b6a27a289adc8ec7f1aa32.tar
isda-edccef5270049ae707b6a27a289adc8ec7f1aa32.tar.bz2
isda-edccef5270049ae707b6a27a289adc8ec7f1aa32.tar.zst
doc installation
-rw-r--r--readme.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/readme.md b/readme.md
index c7d1070..a8053e2 100644
--- a/readme.md
+++ b/readme.md
@@ -17,6 +17,18 @@ it will be assigned to that worker. The worker will then carry out the work and
mark the task as completed. If workers disconnect (crash) while working, all
assigned tasks will be moved back to the queue.
+## Installation
+
+Install the queue server with `cargo install --path .`. The worker scripts dont
+need installation.
+
+For ArchLinux there exist PKGBUILDs for both
+[workers](https://codeberg.org/metamuffin/pkgbuilds/src/branch/master/isdaw-git)
+and
+[the queue server](https://codeberg.org/metamuffin/pkgbuilds/src/branch/master/isdad-git);
+Both also available pre-built on
+[pkg.metamuffin.org](https://pkg.metamuffin.org)
+
## Usage
First start the queue daemon process. It will save its state to JSON files in
@@ -24,7 +36,7 @@ its working directory. As its first argument supply the global configuration
file.
```
-cargo run -- config.yaml
+isdad config.yaml
```
The configuration file contains two keys read be the daemon `bind_port` and