Skip to content

Commit

Permalink
Update README for installation [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
danielpclark committed Oct 10, 2017
1 parent bd4464c commit 81407e8
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,39 @@ a secondary system.

## Installation

To use the install script you need to have the following commands available on your
system `curl wget unzip sudo cc` and possibly other build essentials for C. For Ubuntu
and Docker images of Ubuntu you can install these prerequisites with:

```bash
apt-get update && apt-get install curl wget unzip sudo build-essential
```

_NOTE: if you are not root you may need to precede `apt-get` with `sudo`_


The `install.sh` script will check for Rust and aescrypt and proceed to install them
if they are missing _(it will ask you if you want to install Rust)_.

First download the installation script locally.

```bash
curl https://raw.githubusercontent.com/danielpclark/abrute/master/install.sh > install.sh
```

Then verify that the contents of the installation script is safe to use (a no brainer).

Then run

```bash
bash install.sh
```

This install script will use sudo to copy the binary directly to `/usr/bin` and make the
command `abrute` available to you everywhere.

### Manual Installation

First you need to have aescrypt installed.

```bash
Expand Down

0 comments on commit 81407e8

Please sign in to comment.