summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 18d4b91..3fd2e81 100644
--- a/README.md
+++ b/README.md
@@ -33,6 +33,28 @@ tar -tf build/sia-server-v*.tar.zst | less
All relevant build results are part of this Zstandard-compressed tar archive.
+## Usage
+
+On a `linux/amd64` machine the Sia server can be launched with default
+configuration in an unpacked deploy archive.
+
+```
+./sia-server-linux-amd64
+```
+
+The command line interface is documented in the help page.
+
+```
+./sia-server-linux-amd64 -help
+```
+
+The configuration file format can be looked up based on the
+`configs/default.json` file.
+
+The files in the `systemd` folder are provided for integration into
+[systemd][4]-based Linux distributions.
+
[1]: https://homematic-ip.com/
[2]: https://openccu.de/
[3]: https://homematic-ip.com/en/product/window-and-door-contact-optical
+[4]: https://systemd.io/