From fe83a2512fb89e7e179e883ec7ca1c16d7566e0d Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Wed, 22 Dec 2021 22:56:39 +0200 Subject: [PATCH] [documentation] Minor fixup. --- .../{installations.rst => installation.rst} | 35 ++++++++++++++++--- 1 file changed, 30 insertions(+), 5 deletions(-) rename documentation/{installations.rst => installation.rst} (94%) diff --git a/documentation/installations.rst b/documentation/installation.rst similarity index 94% rename from documentation/installations.rst rename to documentation/installation.rst index 0b564a0..1dbb775 100644 --- a/documentation/installations.rst +++ b/documentation/installation.rst @@ -21,9 +21,11 @@ Installation Download prebuilt executables ----------------------------- + .. warning :: No executables are currently available for download! + Please consult the `build from sources section <#build-from-sources>`__ for now. @@ -33,19 +35,24 @@ Build from sources ------------------ + + Install the prerequisites ......................... + * Ubuntu / Debian: :: apt-get install git-core apt-get install golang + * OpenSUSE: :: zypper install git-core zypper install go + * other Linux / FreeBSD / OpenBSD / OSX: * fetch and install Go from: https://golang.org/dl @@ -53,9 +60,12 @@ Install the prerequisites * install Git; + + Prepare the environment ....................... + :: mkdir -- \ @@ -66,9 +76,12 @@ Prepare the environment # + + Fetch the sources ................. + Either clone the full Git repository: :: git clone \ @@ -77,6 +90,7 @@ Either clone the full Git repository: :: /tmp/kawipiko/src \ # + Either fetch and extract the latest sources bundle: :: curl \ @@ -93,9 +107,12 @@ Either fetch and extract the latest sources bundle: :: # + + Build the dynamic executables ............................. + Compile the (dynamic) executables: :: cd /tmp/kawipiko/src/sources @@ -104,8 +121,9 @@ Compile the (dynamic) executables: :: env \ GOPATH=/tmp/kawipiko/go \ go build \ - -ldflags 'all=-s' \ -gcflags 'all=-l=4' \ + -ldflags 'all=-s' \ + -trimpath \ -o /tmp/kawipiko/bin/kawipiko \ ./cmd/wrapper.go \ # @@ -114,8 +132,9 @@ Compile the (dynamic) executables: :: env \ GOPATH=/tmp/kawipiko/go \ go build \ - -ldflags 'all=-s' \ -gcflags 'all=-l=4' \ + -ldflags 'all=-s' \ + -trimpath \ -o /tmp/kawipiko/bin/kawipiko-server \ ./cmd/server.go \ # @@ -124,16 +143,20 @@ Compile the (dynamic) executables: :: env \ GOPATH=/tmp/kawipiko/go \ go build \ - -ldflags 'all=-s' \ -gcflags 'all=-l=4' \ + -ldflags 'all=-s' \ + -trimpath \ -o /tmp/kawipiko/bin/kawipiko-archiver \ ./cmd/archiver.go \ # + + Build the static executables ............................ + Compile the (static) executables: :: cd /tmp/kawipiko/src/sources @@ -170,16 +193,18 @@ Compile the (static) executables: :: -gcflags 'all=-l=4' \ -ldflags 'all=-s' \ -trimpath \ + -o /tmp/kawipiko/bin/kawipiko-archiver \ ./cmd/archiver.go \ # + + Deploy the executables ...................... -(Basically just copy the two executables anywhere on the system, or any compatible remote system.) -:: +Just copy the two executables anywhere on the system, or any compatible remote system: :: cp \ -t /usr/local/bin \