Skip to content

Latest commit

 

History

History
17 lines (11 loc) · 1.35 KB

install.md

File metadata and controls

17 lines (11 loc) · 1.35 KB

Installation

MUTN is still in early development and thus no installation packages are officially distributed.

For now, please manually install the binaries from the latest release or compile from source. All pre-built binaries were compiled with CGO disabled and thus are libc-independent.

Additionally, MUTN is available as a source package ("mutn") on the AUR.

Please note that the server binary (available in 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.

Please see the usage guide for help getting started.

Dependencies (required for all installations)

  • GnuPG command-line utility (gpg command; will not be required in the future) for encryption/decryption
  • A text editor (preferably CLI-based) for writing entry notes
  • A private key for SSH key-based authentication is required to use MUTN/libmutton in online/synced mode