Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Build Steps in "develop" branch #1015

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,39 @@ brew install amass

The volume argument allows the Amass graph database to persist between executions and output files to be accessed on the host system. The first field (left of the colon) of the volume option is the amass output directory that is external to Docker, while the second field is the path, internal to Docker, where amass will write the output files.

### From Source
### Building the "amass" binary from source on the "develop" branch

1. Install [Go](https://golang.org/doc/install) and setup your Go workspace
2. Download OWASP Amass by running `go install -v github.com/owasp-amass/amass/v4/...@master`
3. At this point, the binary should be in `$GOPATH/bin`
2. At this point, the binary should be in `$GOPATH/bin`

The amass_engine must be built first as it is embedded within the "amass" project
3. Extract the amass_engine source code, e.g.:
git clone {engine repository or fork}
cd engine
git checkout develop

4. Build the amass_engine
cd cmd/amass_engine/
go build
go install

5. Extract the amass source code, e.g.:
git clone {amass repository or fork}
cd amass
git checkout develop

6. Copy the amass_engine binary where it's needed:
cp ~/go/bin/amass_engine resources/.

7. Build the amass project:
cd cmd/amass
go build
go install






## Documentation [![GoDoc](https://pkg.go.dev/badge/github.com/owasp-amass/amass/v4?utm_source=godoc)](https://pkg.go.dev/github.com/owasp-amass/amass/v4)

Expand Down