Documentation
Installation

Binary Releases

We are now shipping binaries for each of the releases so that you don't even have to build them yourself! How wonderful is that!

If you're stupid enough to trust binaries that I've put together, you can download them from the releases (opens in a new tab) page.

Using go install

If you have a Go (opens in a new tab) environment ready to go (at least go 1.19), it's as easy as:

go install github.com/LeoFVO/gosurp@latest

PS: You need at least go 1.19 to compile gosurp.

Using Docker

docker pull ghcr.io/leofvo/gosurp:latest
docker run gosurp:latest

Building From Source

Prerequisites

Since this tool is written in Go (opens in a new tab) you need to install the Go language/compiler/etc. Full details of installation and set up can be found on the Go language website (opens in a new tab). Once installed you have two options. You need at least go 1.19 to compile gosurp.

Clone the repository

git clone git@github.com:LeoFVO/gosurp.git

Compiling

gosurp has external dependencies, and so they need to be pulled in first:

go get && go build

This will create a gosurp binary for you. If you want to install it in the $GOPATH/bin folder you can run:

go install