diff options
| author | xengineering <me@xengineering.eu> | 2025-12-20 15:28:23 +0100 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2025-12-20 15:28:23 +0100 |
| commit | 9db4822c5b0991b0c19c3bb028110449a6ce8b82 (patch) | |
| tree | 0b268e90df0555fe10ad6c5dc75333da03250f17 | |
| parent | 134991968b8661aef17468aa3358af29a21b9f32 (diff) | |
| download | sia-server-9db4822c5b0991b0c19c3bb028110449a6ce8b82.tar sia-server-9db4822c5b0991b0c19c3bb028110449a6ce8b82.tar.zst sia-server-9db4822c5b0991b0c19c3bb028110449a6ce8b82.zip | |
README.md: Add usage instructions
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
@@ -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/ |