From 8c7ed3dc6274c153dd23c44061a052abde8d26f4 Mon Sep 17 00:00:00 2001 From: Ciprian Dorin Craciun Date: Thu, 23 Dec 2021 21:10:19 +0200 Subject: [PATCH] [documentation] Update installation instructions to point to GitHub releases page. --- documentation/installation.rst | 49 +++++++++++++++++++++++++++++----- 1 file changed, 43 insertions(+), 6 deletions(-) diff --git a/documentation/installation.rst b/documentation/installation.rst index ec4f5d0..861f625 100644 --- a/documentation/installation.rst +++ b/documentation/installation.rst @@ -27,11 +27,48 @@ Download prebuilt executables ----------------------------- -.. warning :: +See the `releases page on GitHub `__. - No executables are currently available for download! +As a shortcut, the following are the self-contained and statically linked +all-in-one server and archiver executables +(for x86_64 / amd64 processors): - Please consult the `build from sources section <#build-from-sources>`__ for now. + * ``__ + * ``__ + * ``__ + * ``__ + + +For example, assuming one wants the ``preview`` version, +one can run the following commands: :: + + curl \ + -s -S -f -L \ + -o /tmp/kawipiko-server \ + https://github.com/volution/kawipiko/releases/download/preview/kawipiko-server--linux \ + # + + curl \ + -s -S -f -L \ + -o /tmp/kawipiko-archiver \ + https://github.com/volution/kawipiko/releases/download/preview/kawipiko-archiver--linux \ + # + + curl \ + -s -S -f -L \ + -o /tmp/kawipiko \ + https://github.com/volution/kawipiko/releases/download/preview/kawipiko--linux \ + # + + chmod a=rx /tmp/kawipiko-server + chmod a=rx /tmp/kawipiko-archiver + chmod a=rx /tmp/kawipiko + + +One can replace ``preview`` with ``v0.x.y`` (see the releases page). + + +One can replace ``linux`` with ``freebsd``, ``openbsd`` or ``darwin``. @@ -65,7 +102,7 @@ Install the prerequisites * other Linux / FreeBSD / OpenBSD / OSX: - * fetch and install Go from: ``__ + * fetch and install Go from ``__; * add ``/usr/local/go/bin`` to your ``PATH``; * install Git; @@ -127,7 +164,7 @@ Compile the (dynamic) executables: :: cd /tmp/kawipiko/src/sources - #### build `kawipiko` dynamic all-in-one executable + #### build `kawipiko` all-in-one dynamic executable env \ GOPATH=/tmp/kawipiko/go \ go build \ @@ -171,7 +208,7 @@ Compile the (static) executables: :: cd /tmp/kawipiko/src/sources - #### build `kawipiko` static all-in-one executable + #### build `kawipiko` all-in-one static executable env \ GOPATH=/tmp/kawipiko/go \ go build \