Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Commit

Permalink
Add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Ullaakut authored Feb 10, 2019
1 parent 3c03947 commit c23cadd
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,20 @@ Exposing the docker API on the internet is a tremendous risk, as it can let mali
<img src="images/Gorsair.png" width="300px"/>
</p>

## Install

### From a release

Set the `GORSAIR_VERSION` to whatever release you are interested in and run the following command to install gorsair.

`curl https://github.com/Ullaakut/Gorsair/releases/download/$GORSAIR_VERSION/gorsair_darwin_amd64 --output /usr/local/bin/gorsair`

### From the sources

* Make sure that you have a go version that supports modules (versions 1.11 and above)
* Make sure that your environment contains the `GO111MODULE` variable set to `on`
* Run `go build -o /usr/local/bin/gorsair cmd/*.go` from the root of this repository

## Command line options

* **`-t`, `--targets`**: Set targets according to the [nmap target format](https://nmap.org/book/man-target-specification.html). Required. Example: `--targets="192.168.1.72,192.168.1.74"`
Expand Down

0 comments on commit c23cadd

Please sign in to comment.