]> Sergey Matveev's repositories - tofuproxy.git/blobdiff - doc/install.texi
No redo, refactor project building, simplify it
[tofuproxy.git] / doc / install.texi
diff --git a/doc/install.texi b/doc/install.texi
new file mode 100644 (file)
index 0000000..4e71352
--- /dev/null
@@ -0,0 +1,26 @@
+@node Install
+@unnumbered Install
+
+Download the tarball with the signature from website and build it.
+You need more or less modern @url{https://go.dev/, Go} and C-compiler
+with @url{https://facebook.github.io/zstd/, libzstd} headers if you need
+WARCs support.
+
+@example
+$ [fetch|wget] http://www.tofuproxy.stargrave.org/download/tofuproxy-@value{VERSION}.tar.zst
+$ [fetch|wget] http://www.tofuproxy.stargrave.org/download/tofuproxy-@value{VERSION}.tar.zst.sig
+$ gpg --verify tofuproxy-@value{VERSION}.tar.zst.sig tofuproxy-@value{VERSION}.tar.zst
+$ zstd -d < tofuproxy-@value{VERSION}.tar.zst | tar xf -
+$ cd tofuproxy-@value{VERSION}
+$ ./build
+@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.
+
+Also there is @url{https://yggdrasil-network.github.io/, Yggdrasil}
+accessible address: @url{http://y.www.tofuproxy.stargrave.org}.