GitHubMirror/MUTN
1
0
Fork 0
mirror of https://github.com/rwinkhart/MUTN.git synced 2026-08-28 04:46:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify key-based authentication requirement in man page

Browse Source
This commit is contained in:
RandyTheSilly
2024-07-16 16:05:29 -04:00
parent c6734dd283
commit 0a56130d94
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/man
+4 -2
View File
@@ -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 .SH NAME
\fBmutn\fR - Simple, self-hosted, SSH-synchronized password management based on libmutton. It is the successor to sshyp. \fBmutn\fR - Simple, self-hosted, SSH-synchronized password management based on libmutton. It is the successor to sshyp.
@@ -7,7 +7,7 @@
Usage: mutn [/<entry name> [argument] [option]] | [argument] Usage: mutn [/<entry name> [argument] [option]] | [argument]
.SH DESCRIPTION .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 .SH EXAMPLES
Setting up MUTN for the first time: Setting up MUTN for the first time:
@@ -92,6 +92,8 @@ add:
.SH SETUP .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. 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. 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: Once this has been done, you may proceed with the client setup: