diff --git a/README.md b/README.md index 5055d33..10676ae 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,6 @@ Additionally, MUTN is available as a source package ("[mutn](https://aur.archlin After installing, please review the [usage guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/usage.md). # Roadmap -#### Release v0.2.1 -- [x] libmutton v0.2.1 - - [x] Only run getSSHClient once to prevent being asked for keyfile password multiple times - - [x] Ensure all config files and entry files are created with 0600 permissions - - [x] Add fail-specific error codes - - [x] Document in man page -- [x] Split into separate repos - 1. libmutton: backend package (rename to core), sync package, libmuttonserver - 3. MUTN: cli package #### Release v0.3.0 - [ ] Replace Glamour with a more minimal Markdown renderer (likely custom) #### Release v0.4.0 diff --git a/docs/man b/docs/man index 9c013db..b1fb3ab 100644 --- a/docs/man +++ b/docs/man @@ -1,4 +1,4 @@ -.TH MUTN 1 "06 August 2024" "v0.2.0" "MUTN man page" +.TH MUTN 1 "13 August 2024" "v0.2.1" "MUTN man page" .SH NAME \fBmutn\fR - Simple, self-hosted, SSH-synchronized password and note management based on libmutton. It is the successor to sshyp. diff --git a/docs/release-notes-archive/2024.md b/docs/release-notes-archive/2024.md index 170b767..4f12345 100644 --- a/docs/release-notes-archive/2024.md +++ b/docs/release-notes-archive/2024.md @@ -1,4 +1,38 @@ -**WARNING: AS MUTN AND LIBMUTTON HAVE NOT YET REACHED v1.0.0, [BREAKING CHANGES](https://github.com/rwinkhart/libmutton/blob/main/wiki/breaking.md) IN FUTURE UPDATES ARE PLANNED** +**WARNING: AS LIBMUTTON HAS NOT YET REACHED v1.0.0, [BREAKING CHANGES](https://github.com/rwinkhart/libmutton/blob/main/wiki/breaking.md) IN FUTURE UPDATES ARE PLANNED** + +**MUTN v0.2.1** +Built with libmutton v0.2.1 +August 13, 2024 + +# The Tripe Transmission Update - Patch 1 + +This release marks the completion of splitting MUTN and [libmutton](https://github.com/rwinkhart/libmutton) into separate repositories. The server binary must now be downloaded from the [libmutton releases page](https://github.com/rwinkhart/libmutton/releases). + +Please see the [installation guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/install.md) for updated instructions. + +## Breaking Changes +- The server binary must also be updated to v0.2.1 (grab it [here](https://github.com/rwinkhart/libmutton/releases/tag/v0.2.1)) + +## Features +- From libmutton v0.2.1: + - MUTN will now remove the previous device ID from the server when creating a new one + - Exit codes are now specific to the type of error encountered + +## Fixes +- From libmutton v0.2.1: + - The user is no longer prompted for their ssh keyfile passphrase multiple times during synchronization + - Config/entry files are now created with 0600 permissions + - The TOTP copy message is no longer unnecessarily verbose +- Function documentation is now properly formatted for display on pkg.go.dev + +## Dependencies +- Bumps (direct and indirect) + - golang.org/x/sys: v0.23.0 => v0.24.0 +- New (direct) + - github.com/rwinkhart/libmutton: v0.2.1 + - Was previously included in this repo + +--- **MUTN v0.2.0** August 06, 2024 diff --git a/src/cli/1globals.go b/src/cli/1globals.go index c1883d8..2d2f1f4 100644 --- a/src/cli/1globals.go +++ b/src/cli/1globals.go @@ -11,7 +11,7 @@ var ( ) const ( - MUTNVersion = "0.2.B" // untagged releases feature a letter suffix corresponding to the eventual release version, e.g "0.2.A" -> "0.2.0", "0.2.B" -> "0.2.1" + MUTNVersion = "0.2.1" // untagged releases feature a letter suffix corresponding to the eventual release version, e.g "0.2.A" -> "0.2.0", "0.2.B" -> "0.2.1" AnsiBold = "\033[1m" ansiBlackOnWhite = "\033[38;5;0;48;5;15m" diff --git a/wiki/install.md b/wiki/install.md index 2d4122b..f88f20b 100644 --- a/wiki/install.md +++ b/wiki/install.md @@ -5,7 +5,7 @@ For now, please manually install the binaries from the [latest release](https:// Additionally, MUTN is available as a source package ("[mutn](https://aur.archlinux.org/packages/mutn)") on the AUR. -Please note that the server binary must be called "libmuttonserver" in order for clients to successfully reach it. +Please note that the server binary (available in [libmutton releases](https://github.com/rwinkhart/libmutton/releases)) 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/completions.md). diff --git a/wiki/usage.md b/wiki/usage.md index b9c40a0..feb6137 100644 --- a/wiki/usage.md +++ b/wiki/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 server binary _**MUST**_ be in your $PATH and _**MUST**_ be named "libmuttonserver" for clients to successfully reach it. +The libmutton server software is shipped as its own dedicated binary (in [libmutton releases](https://github.com/rwinkhart/libmutton/releases)) 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