Skip to content

Commit

Permalink
docs: installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
creativeprojects committed May 11, 2021
1 parent 89fbb33 commit 6ec5177
Showing 1 changed file with 25 additions and 21 deletions.
46 changes: 25 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ With resticprofile:
* **[new for v0.10.0]** You can use a template syntax in your configuration file
* **[new for v0.11.0]** You can generate scheduled tasks using *crond*
* **[new for v0.12.0]** Get backup statistics in your status file
* **[new for v0.14.0]** Automatically clear up [stale locks](#locks)

The configuration file accepts various formats:
* [TOML](https://github.com/toml-lang/toml) : configuration file with extension _.toml_ and _.conf_ to keep compatibility with versions before 0.6.0
Expand All @@ -46,9 +47,10 @@ For the rest of the documentation, I'll be showing examples using different form
* [resticprofile](#resticprofile)
* [Table of Contents](#table-of-contents)
* [Requirements](#requirements)
* [Installation (macOS, Linux & other unixes)](#installation-macos-linux--other-unixes)
* [Installation](#installation)
* [Homebrew (all macOS, Linux on amd64)](#homebrew-all-macos-linux-on-amd64)
* [Note on installing on Linux via Homebrew](#note-on-installing-on-linux-via-homebrew)
* [Via a script (macOS, Linux & other unixes)](#via-a-script-macos-linux--other-unixes)
* [Installation for Windows using bash](#installation-for-windows-using-bash)
* [Manual installation (Windows)](#manual-installation-windows)
* [Ansible](#ansible)
Expand Down Expand Up @@ -129,29 +131,11 @@ Please note I use resticprofile on multiple Debian (and Debian based) distributi

**This is at _beta_ stage. Please avoid using it in production. Or at least test carefully first. Even though I'm using it on my servers, I cannot guarantee all combinations of configuration are going to work properly for you.**

# Installation (macOS, Linux & other unixes)

Here's a simple script to download the binary automatically. It works on mac OS X, FreeBSD and Linux:

```
$ curl -sfL https://raw.githubusercontent.com/creativeprojects/resticprofile/master/install.sh | sh
```

It should copy resticprofile in a `bin` directory under your current directory.

If you need more control, you can save the shell script and run it manually:

```
$ curl -LO https://raw.githubusercontent.com/creativeprojects/resticprofile/master/install.sh
$ chmod +x install.sh
$ sudo ./install.sh -b /usr/local/bin
```

It will install resticprofile in `/usr/local/bin/`
# Installation

## Homebrew (all macOS, Linux on amd64)

There's an experimental [homebrew](https://brew.sh/) tap for resticprofile:
There's a [homebrew](https://brew.sh/) tap for resticprofile:

```
$ brew tap creativeprojects/tap
Expand Down Expand Up @@ -181,6 +165,26 @@ Depending on your distribution you will need to install gcc:
* `$ sudo apt install gcc`


## Via a script (macOS, Linux & other unixes)

Here's a simple script to download the binary automatically. It works on mac OS X, FreeBSD and Linux:

```
$ curl -sfL https://raw.githubusercontent.com/creativeprojects/resticprofile/master/install.sh | sh
```

It should copy resticprofile in a `bin` directory under your current directory.

If you need more control, you can save the shell script and run it manually:

```
$ curl -LO https://raw.githubusercontent.com/creativeprojects/resticprofile/master/install.sh
$ chmod +x install.sh
$ sudo ./install.sh -b /usr/local/bin
```

It will install resticprofile in `/usr/local/bin/`

## Installation for Windows using bash

You can use the same script if you're using bash in Windows (via WSL, git bash, etc.)
Expand Down

0 comments on commit 6ec5177

Please sign in to comment.