From cf796c984d05d0836699a6d38739d4845b791d85 Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Thu, 8 Aug 2024 20:00:04 -0400 Subject: [PATCH] [wiki] Add server binary build info; link to developer guide from README.md --- README.md | 5 +++-- wiki/serverBuild.md | 9 +++++++++ 2 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 wiki/serverBuild.md diff --git a/README.md b/README.md index d4921ad..e0610c8 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@ # libmutton libmutton is a library for building simple, SSH-synchronized password managers in Go. -Do not build projects off of this repo until v0.2.1 is tagged (this repo is currently undergoing a migration process from the [MUTN repo](https://github.com/rwinkhart/MUTN). - > [!WARNING] >It is your responsibility to assess the security and stability of libmutton 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 libmutton. >libmutton is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed. +# Developing Thid-Party Clients +See the [developer guide](https://github.com/rwinkhart/libmutton/blob/main/wiki/developers.md). + # Roadmap #### Release v0.2.1 - [ ] Only run getSSHClient once to prevent being asked for keyfile password multiple times diff --git a/wiki/serverBuild.md b/wiki/serverBuild.md new file mode 100644 index 0000000..cf87367 --- /dev/null +++ b/wiki/serverBuild.md @@ -0,0 +1,9 @@ +## Building libmuttonserver +This repository is also home to the code for the libmuttonserver binary. + +Official binaries are stripped of debug info for size and built without CGO (except for distribution packages) for portability, as follows: +``` +CGO_ENABLED=0 go build -ldflags="-s -w" -trimpath ./libmuttonserver.go +``` + +**Ensure the server binary is named `libmuttonserver`!**