Move documentation to separate directory

[goredo.git] / doc / install.texi

diff --git a/doc/install.texi b/doc/install.texi
new file mode 100644 (file)
index 0000000..b25603b
--- /dev/null
+++ b/doc/install.texi
@@ -0,0 +1,62 @@
+@node Install
+@unnumbered Install
+
+Preferable way is to download tarball with the signature from website:
+
+@example
+$ [fetch|wget] http://www.goredo.cypherpunks.ru/download/goredo-@value{VERSION}.tar.zst
+$ [fetch|wget] http://www.goredo.cypherpunks.ru/download/goredo-@value{VERSION}.tar.zst.sig
+$ gpg --verify goredo-@value{VERSION}.tar.zst.sig goredo-@value{VERSION}.tar.zst
+$ zstd -d < goredo-@value{VERSION}.tar.zst | tar xf -
+$ cd goredo-@value{VERSION}
+$ GOPATH=`pwd` go build go.cypherpunks.ru/goredo
+$ ./goredo -symlinks        # create redo-* commands symlinks
+$ export PATH=`pwd`:$PATH   # let your system know about goredo
+@end example
+
+@include download.texi
+
+You @strong{have to} verify downloaded tarballs integrity and
+authenticity to be sure that you retrieved trusted and untampered
+software. @url{https://www.gnupg.org/, GNU Privacy Guard} is used
+for that purpose.
+
+For the very first time it is necessary to get signing public key and
+import it. It is provided below, but you should check alternative
+resources.
+
+@verbatim
+pub   ed25519/0x3A528DDE952C7E93 2021-01-09 [SC]
+      7531BB84FAF0BF35960C63B93A528DDE952C7E93
+uid   goredo releases <goredo@cypherpunks.ru>
+@end verbatim
+
+@itemize
+
+@item
+@example
+$ gpg --auto-key-locate dane --locate-keys goredo at cypherpunks dot ru
+$ gpg --auto-key-locate wkd --locate-keys goredo at cypherpunks dot ru
+@end example
+
+@item
+@verbatiminclude ../PUBKEY.asc
+
+@end itemize
+
+It is also @command{go get}-able:
+
+@example
+$ go get go.cypherpunks.ru/goredo
+$ goredo -symlinks
+@end example
+
+If you have problems with @code{*.golang.org}'s inability to verify
+authenticity of @code{go.cypherpunks.ru} TLS connection, then you can
+disable their usage by setting @env{GOPRIVATE=go.cypherpunks.ru}. You
+can override CA certificate file path with @env{SSL_CERT_FILE} and
+@env{GIT_SSL_CAINFO} environment variables.
+
+You can obtain development source code with
+@command{git clone git://git.cypherpunks.ru/goredo.git}
+(also you can use @url{https://git.cypherpunks.ru/goredo.git}).