-
Notifications
You must be signed in to change notification settings - Fork 29
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #76 from safedep/develop
Add Support for Community Endpoint for Insights API
- Loading branch information
Showing
9 changed files
with
109 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,16 +27,25 @@ source dependencies and evaluate them against organizational policies. | |
|
||
## Getting Started | ||
|
||
- Download the binary file for your operating system/architecture from the [Official GitHub Releases](https://github.com/safedep/vet/releases) | ||
- Download the binary file for your operating system / architecture from the [Official GitHub Releases](https://github.com/safedep/vet/releases) | ||
|
||
- You can also install the vet using the homebrew in MacOS and Linux | ||
- You can also install `vet` using homebrew in MacOS and Linux | ||
|
||
```bash | ||
brew tap safedep/tap | ||
brew install safedep/tap/vet | ||
``` | ||
|
||
- Get an API key for the vet insights data access for performing the scan | ||
- Alternatively, build from source | ||
|
||
> Ensure $(go env GOPATH)/bin is in your $PATH | ||
```bash | ||
go install github.com/safedep/vet@latest | ||
``` | ||
|
||
- Get an API key for the vet insights data access for performing the scan. | ||
Alternatively, look at [using community endpoint without API key](#using-community-mode) | ||
|
||
```bash | ||
vet auth trial --email [email protected] | ||
|
@@ -62,6 +71,16 @@ vet auth configure | |
vet auth verify | ||
``` | ||
|
||
### Using Community Mode | ||
|
||
Community mode can be used to avoid registering and obtaining an API key. | ||
|
||
```bash | ||
vet auth configure --community | ||
``` | ||
|
||
### Running Scan | ||
|
||
- Run `vet` to identify risks | ||
|
||
```bash | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -39,6 +39,16 @@ vet auth configure | |
|
||
- To renew an API key, you can re-register using the email. Even reach out to us at [[email protected]](mailto:[email protected]) and we would be happy to work with you | ||
|
||
## Using Community Mode | ||
|
||
- You can use community endpoint for Insights API without API key | ||
|
||
```bash | ||
vet auth configure --community | ||
``` | ||
|
||
- For CI job, set environment variable `VET_COMMUNITY_MODE=true` to enable community runtime mode | ||
|
||
## Scanning | ||
|
||
### Scanning Directories | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,9 @@ title: 🚀 Quick Start | |
|
||
![vet Github Releases](/img/vet/vet-github-releases.png) | ||
|
||
- Get an API key for the vet insights data access for performing the scan | ||
- Get an API key for the vet insights data access for performing the scan. | ||
Alternatively, look at [configuration options](configure.md) for | ||
instruction on using community mode without API key. | ||
|
||
```bash | ||
vet auth trial --email [email protected] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters