From c6310582c53a9db32f5907cf0faaffe6a0ad5a8f Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Tue, 16 Jul 2024 16:05:29 -0400 Subject: [PATCH] Clarify key-based authentication requirement in man page --- docs/man | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/man b/docs/man index 977179c..6d83b12 100644 --- a/docs/man +++ b/docs/man @@ -1,4 +1,4 @@ -.TH MUTN 1 "15 July 2024" "v0.2.A" "MUTN man page" +.TH MUTN 1 "16 July 2024" "v0.2.A" "MUTN man page" .SH NAME \fBmutn\fR - Simple, self-hosted, SSH-synchronized password management based on libmutton. It is the successor to sshyp. @@ -7,7 +7,7 @@ Usage: mutn [/ [argument] [option]] | [argument] .SH DESCRIPTION -mutn is a lightweight password, TOTP, and note management program for the CLI. MUTN is self-hosted with a client-server model and expects that you have access to a personal server with a properly configured SSH server (ideally accepting remote connections). +mutn is a lightweight password, TOTP, and note management program for the CLI. MUTN is self-hosted with a client-server model and expects that you have access to a personal server with a properly configured SSH server. .SH EXAMPLES Setting up MUTN for the first time: @@ -92,6 +92,8 @@ add: .SH SETUP libmutton operates on a client-server model, and thus sync support requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH. +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 and configured on the server. Once this has been done, you may proceed with the client setup: