mirror of
https://github.com/rwinkhart/MUTN.git
synced 2026-09-05 08:37:20 -04:00
Update README.md
This commit is contained in:
@@ -1,41 +1,45 @@
|
|||||||
# MUTN Password Manager
|
# MUTN Password Manager
|
||||||
Pronounced as: "mutton", "muh·tn"
|
Pronounced as: "mutton", "muh·tn"
|
||||||
|
|
||||||
MUTN is a simple, self-hosted, SSH-synchronized password manager based on libmutton. It is the successor to [sshyp](https://github.com/rwinkhart/sshyp).
|
MUTN is a simple, self-hosted, SSH-synchronized password and note manager based on libmutton. It is the successor to [sshyp](https://github.com/rwinkhart/sshyp).
|
||||||
|
|
||||||
> [!WARNING]
|
> [!WARNING]
|
||||||
>It is your responsibility to assess the security and stability of MUTN and to ensure it meets your needs before using it.
|
>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.
|
>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.
|
>MUTN is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed.
|
||||||
|
|
||||||
|
# Demo
|
||||||
|

|
||||||
|
|
||||||
# Mission Statement
|
# Mission Statement
|
||||||
MUTN aims to make it as simple as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion.
|
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.
|
||||||
|
|
||||||
# Building
|
# Building
|
||||||
See the [building guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md).
|
See the [building guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md).
|
||||||
|
|
||||||
# Roadmap
|
# Roadmap
|
||||||
#### Release v0.2.0 - Make repo public - No binaries
|
#### Release v0.2.1
|
||||||
- Add fail-specific error codes
|
- [ ] Only run getSSHClient once to prevent being asked for keyfile password multiple times
|
||||||
- Address most TODOs
|
- [ ] After this, handle all errors in client.go
|
||||||
- Hunt and fix bugs in preparation for public debut
|
- [ ] Ensure all config files and entry files are created with 0600 permissions
|
||||||
#### Release v0.2.1 - No binaries
|
- [ ] Add fail-specific error codes
|
||||||
- Replace init with interactive ttyPod-based menu
|
- [ ] Split into separate repos
|
||||||
#### Release v0.3.0 - x86_64_v1 binary
|
1. libmutton
|
||||||
- Swap to native encryption, remove GPG support
|
2. libmutton-server
|
||||||
#### Release v0.4.0 - x86_64_v1 binary
|
3. MUTN
|
||||||
- Password aging support
|
#### Release v0.3.0
|
||||||
- Add password aging info to entry names
|
- [ ] Replace Glamour with a more minimal Markdown renderer (likely custom)
|
||||||
- Make constant character count to easily trim for user interaction
|
#### Release v0.4.0
|
||||||
#### Release v1.0.0 - Distribution packages (from here on out)
|
- [ ] Swap to native (cascade) encryption (custom)
|
||||||
- Perform extensive testing, fixing, and optimizing
|
- [ ] Implement "netpin" (quick-unlock) with new encryption
|
||||||
- Create artwork
|
#### Release v0.5.0
|
||||||
- Create manpage
|
- [ ] Password aging support
|
||||||
- Create packaging script
|
- [ ] Append UNIX timestamp to entry names
|
||||||
#### Release v1.1.0
|
- [ ] Add yellow/red dot indicators to entry list readout for when passwords should be changed
|
||||||
- Cascading encryption support
|
#### Release v0.6.0
|
||||||
#### Release v1.2.0
|
- [ ] Re-implement init menu
|
||||||
- Custom color scheme support
|
- [ ] Implement tweak menu
|
||||||
#### Release v1.3.0
|
- [ ] Add refresh/re-encrypt functionality
|
||||||
- Add build option for breaking markdown support and menus into separate binaries
|
#### Release v1.0.0 - Distribution packages
|
||||||
- Greatly reduces startup time
|
- [ ] Create packaging scripts
|
||||||
|
- Perform extensive testing
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
.TH MUTN 1 "16 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 and note management based on libmutton. It is the successor to sshyp.
|
||||||
|
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
Usage: mutn [/<entry name> [argument] [option]] | [argument]
|
Usage: mutn [/<entry name> [argument] [option]] | [argument]
|
||||||
|
|||||||
Reference in New Issue
Block a user