Files
MUTN/README.md
T

59 lines
2.7 KiB
Markdown

![banner](https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/artwork/MUTN-banner.webp)
---
Pronounced as: "mutton", "muh·tn"
MUTN is a simple, self-hosted, SSH-synchronized password and note manager based on [libmutton](https://github.com/rwinkhart/libmutton). It is the successor to [sshyp](https://github.com/rwinkhart/sshyp).
> [!WARNING]
>It is your responsibility to assess the security and stability of MUTN and to ensure it meets your needs before using it.
>I am not responsible for any data loss or breaches of your information resulting from the use of MUTN.
>MUTN is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed.
# Demo Tape
![mutn-demo.webp](https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/mutn-vhs/mutn-demo.webp)
# Mission Statement
MUTN aims to make it as easy as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion.
# Installation/Building
See the [installation guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/install.md).
Additionally, MUTN is available as a source package ("[mutn](https://aur.archlinux.org/packages/mutn)") on the AUR.
After installing, please review the [usage guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/usage.md).
# Roadmap
### Release v0.3.0
- [ ] libmutton v0.3.0
- [ ] Add refresh/re-encrypt functionality
- [ ] Re-implement init menu
- [ ] Implement tweak menu
- [ ] Bump Glamour version and switch to fully-compliant Markdown (do not preserve new lines)
- [x] Add experimental build option for building with [BEAN](https://github.com/Trojan2021/BEAN) instead of Glamour
### Release v0.4.0
- [ ] Evaluate defaulting to building w/Bean over Glamour
- [ ] Verify having Glamour in go.mod does not impact binary size/speed (drop it if it does)
### Release v0.5.0
- [ ] libmutton v0.4.0
- [ ] Password aging support
- [ ] Append UNIX timestamp to entry names
- [ ] Trim timestamps to allow for vanity entry names in the following cases:
- [ ] Argument parsing
- [ ] Shell completions
- [ ] Entry list readout
- [ ] Add yellow/red dot indicators to entry list readout for when passwords should be changed
### Release v0.6.0
- [ ] libmutton v0.5.0
- [ ] Swap to native (cascading) encryption
- [ ] Implement "netpin" (quick-unlock) with new encryption
### Release v1.0.0 - Distribution packages
- [ ] Evaluate implementing custom types/interfaces (where applicable)
- [ ] Create packaging scripts
- [x] Stable source PKGBUILD
- [x] Stable source APKBUILD
- [ ] Debian/Ubuntu
- [ ] Fedora
- [ ] FreeBSD
- [ ] Windows installer
- Perform extensive testing