v0.2.0

Currently only supported on Windows. Choose your selected interface (MunkeyService.zip for the GUI, MunkeyCli.zip for the CLI). *Both interfaces require MunkeyService.zip as an external dependency`.

Install Background Service

1. Unzip the contents of MunkeyService.zip.
2. Double-click munkey.exe to start, or run from the command line to use command-line arguments.
3. If prompted, enable firewall access over a Private network. This is required for service discovery to work. DO NOT run this service on a public network.

Install GUI App

1. Unzip the contents of MunkeyApp.zip.
2. Double-click the .cer file and click "Install certificate." This is required due to the pre-release version of Munkey using self-signed certificates for the pre-release build.
3. Double-click the .msix file to install the program.
4. Ensure that munkey.exe from the MunkeyService package is running in the background before use (see README for details).

Install CLI App

1. Unzip the contents of MunkeyCli.zip to your preferred installation location.
2. Add the extracted path to your system's PATH environment variable. On Windows, this can be done by searching Edit the system environment variables, clicking Environment Variables, selecting PATH in the list of user variables, clicking Edit, then New, and adding the installation path here.
3. Invoke MunkeyCli.exe from the command line. For usage, see the README or run MunkeyCli -h.

MVP

Initial Feature List

• Interface via a command-line shell by @jtcooper10 in #1
• Ability to synchronize data between local peers by @jtcooper10 in #8
• Basic peer discovery via mDNS by @jtcooper10 in #11
• Basic key-value database operations by @jtcooper10 in #7
• Database Persistence to Disk by @jtcooper10 in #9
• Encryption of vault contents by @jtcooper10 in #10
• Preview of TLS for basic in-transit encryption by @jtcooper10 in #12

Full Changelog: https://github.com/jtcooper10/munkey/commits/v0.0.1

No binaries are included during pre-release. Please build from source.