mirror
/
restic
mirror of https://github.com/restic/restic.git
1
0
Fork 0
Code Issues Releases Wiki Activity
restic/doc/installation.rst

80 lines
1.9 KiB
ReStructuredText
Raw Normal View History

Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
Installation
============
Packages
--------
Mac OS X
~~~~~~~~~
If you are using Mac OS X, you can install restic using the
Fixed word-o. ("Package", not "packet".) Fixed a word-o. homebrew is a package manager, not a packet manager. :)
2017-08-31 20:34:53 +00:00
`homebrew <http://brew.sh/>`__ package manager:
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
doc: Use "code-block console" for session blocks
2017-04-17 20:43:04 +00:00
.. code-block:: console
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
$ brew tap restic/restic
$ brew install restic
Add instruction on how to install restic using Nix
2017-09-27 20:37:43 +00:00
Arch Linux
~~~~~~~~~~
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
Add instruction on how to install restic using Nix
2017-09-27 20:37:43 +00:00
On `Arch Linux <https://www.archlinux.org/>`__, there is a package called ``restic-git`` which can be
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
installed from AUR, e.g. with ``pacaur``:
doc: Use "code-block console" for session blocks
2017-04-17 20:43:04 +00:00
.. code-block:: console
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
$ pacaur -S restic-git
Add instruction on how to install restic using Nix
2017-09-27 20:37:43 +00:00
Nix & NixOS
~~~~~~~~~~~
If you are using `Nix <https://nixos.org/nix/>`__ or `NixOS <https://nixos.org/>`__
there is a package available named ``restic``.
Fix wrong quotes for command in installation.
2017-09-29 08:08:24 +00:00
It can be installed uisng ``nix-env``:
Add instruction on how to install restic using Nix
2017-09-27 20:37:43 +00:00
.. code-block:: console
$ nix-env --install restic
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
Pre-compiled Binary
-------------------
You can download the latest pre-compiled binary from the `restic release
page <https://github.com/restic/restic/releases/latest>`__.
From Source
-----------
restic is written in the Go programming language and you need at least
Update minimum Go version Minimum version is now 1.8 according to build.go (from latest master, cloned a few minutes ago): ``` paul@voga:~/third-dev/restic$ go run build.go Go version go1.7.4 detected, restic requires at least Go 1.8 exit status 1 ```
2017-08-24 18:51:11 +00:00
Go version 1.8. Building restic may also work with older versions of Go,
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
but that's not supported. See the `Getting
started <https://golang.org/doc/install>`__ guide of the Go project for
instructions how to install Go.
In order to build restic from source, execute the following steps:
doc: Use "code-block console" for session blocks
2017-04-17 20:43:04 +00:00
.. code-block:: console
Documentation: Refactor and switch to Sphinx * convert documentation to reStructuredText * switch from mkdocs to sphinx * rewrite README.md (now .rst) to include less information and be more attractive
2017-04-17 18:53:38 +00:00
$ git clone https://github.com/restic/restic
[...]
$ cd restic
$ go run build.go
You can easily cross-compile restic for all supported platforms, just
supply the target OS and platform via the command-line options like this
(for Windows and FreeBSD respectively):
::
$ go run build.go --goos windows --goarch amd64
$ go run build.go --goos freebsd --goarch 386
The resulting binary is statically linked and does not require any
libraries.
At the moment, the only tested compiler for restic is the official Go
compiler. Building restic with gccgo may work, but is not supported.