From 871897b6cea7481919be9ccf81f37844a24c244a Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Tue, 6 Aug 2024 15:24:17 -0400 Subject: [PATCH] [wiki/MUTN] Link to release page from install guide; mention server binary must be called "libmuttonserver" --- wiki/MUTN/install.md | 6 ++++-- wiki/MUTN/usage.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/wiki/MUTN/install.md b/wiki/MUTN/install.md index c2c4999..e8267bd 100644 --- a/wiki/MUTN/install.md +++ b/wiki/MUTN/install.md @@ -1,8 +1,10 @@ ## Installation MUTN is still in early development and thus no installation packages are officially distributed. -For now, please [compile from source](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md). +For now, please manually install the binaries from the [latest release](https://github.com/rwinkhart/MUTN/releases) or [compile from source](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md). -After compiling and placing the binaries in your $PATH, it is highly recommended to also download and correctly place/source the relevant [shell completions scripts](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/completions.md). +Please note that the server binary must be called "libmuttonserver" in order for clients to successfully reach it. + +After placing the binaries in your $PATH, it is highly recommended to also download and correctly place/source the relevant [shell completions scripts](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/completions.md). Please see the [usage guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/usage.md) for help getting started. diff --git a/wiki/MUTN/usage.md b/wiki/MUTN/usage.md index b6c6765..454e57e 100644 --- a/wiki/MUTN/usage.md +++ b/wiki/MUTN/usage.md @@ -8,7 +8,7 @@ libmutton operates on a client-server model, and thus sync support requires you For security reasons, libmutton deliberately does not support password-based SSH authentication; you must use key-based authentication to connect to your server (password-protected keys are also supported). You are responsible for setting up SSH connectivity on your own. -The libmutton server software is shipped as its own dedicated binary and must be installed on the server and configured with `libmuttonserver init`. +The libmutton server software is shipped as its own dedicated binary and must be installed on the server and configured with `libmuttonserver init`. The server binary _**MUST**_ be in your $PATH and _**MUST**_ be named "libmuttonserver" for clients to successfully reach it. Once this has been done, you may proceed with the client setup: 1. Install MUTN