Skip to content

Commit

Permalink
docs: move assets, duplicate content to gitbook
Browse files Browse the repository at this point in the history
  • Loading branch information
ojaswa1942 committed Feb 14, 2022
1 parent 2143341 commit 327cd53
Show file tree
Hide file tree
Showing 27 changed files with 55 additions and 14 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Privacy Engineers can use our CLI tool as an MRI for products, applications and

To start off, make sure `docker` is installed. To install docker, you can follow the steps stated in the [official documentation](https://docs.docker.com/engine/install/). You can install Privado CLI in multiple manners:

- [Using `curl` or `wget`](#install-using-curl-or-wget)
- [Using `curl`](#install-using-curl)
- [Using `go`](#install-using-go)
- [Using releases](#install-release-manually)

Expand All @@ -49,7 +49,7 @@ curl -o- https://raw.githubusercontent.com/Privado-Inc/privado/main/install.sh |
To uninstall, simply delete `~/.privado/bin`.

### Install using Go
If you are a GoLang fan, you can use the `go install` to install the Privado CLI:
If you are a GoLang fan, you can use the `go install` command to install the Privado CLI:

```
go install github.com/Privado-Inc/privado@latest
Expand Down Expand Up @@ -93,7 +93,7 @@ To scan a repository, simply run:
```
privado scan <path/to/repository>
```
Depending on repository size and system configuration, scanning can take upto 5-10 minutes. Post completion, the results can be viewed on [localhost:3000](http://localhost:3000).
Depending on repository size and system configuration, time to scan can vary. Post completion, the results can be viewed on [localhost:3000](http://localhost:3000).

<img width="456" alt="privado-scan-completion-snapshot" src="https://user-images.githubusercontent.com/35270649/153745682-3a97e6eb-0696-4536-b8ca-562d31ead1f9.png">

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
20 changes: 16 additions & 4 deletions docs/privado-cli/authenticate-privado.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# Authenticate Privado
# Authenticate Privado

{% hint style="info" %}
**Good to know:** your product docs aren't just a reference of all your features! use them to encourage folks to perform certain actions and discover the value in your product.
{% endhint %}
Privado CLI requires a license key to run scans. To generate a license, run the following command:
```
privado auth <[email protected]>
```
A copy of the license will be emailed to you.

To authenticate and bootstrap the app using the generated license, run:
```
privado bootstrap </path/to/privado-license.json>
```

and done! You are all set to scan your projects and generate compliance reports.

> Please note that generated licenses are valid for 1 year from the date of issue.
> For more information about licensing, feel free to get in touch with us on [Slack](https://join.slack.com/t/devprivops/shared_invite/zt-yk5zcxh3-gj8sS9w6SvL5lNYZLMbIpw) or [Email](mailto:[email protected]).
5 changes: 1 addition & 4 deletions docs/privado-cli/getting-started-with-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ After you have authenticated you can run your first scan.

## Scan your project <a href="#scan-your-project" id="scan-your-project"></a>

Once you have authenticated, change to the project you want to scan and run `privado scan`

IMAGE of Scan

Once you have authenticated, simply run `privado scan <project>`.
Once the scan finishes, we will open the result in your browser.

## Scan Results <a href="#scan-results" id="scan-results"></a>
Expand Down
34 changes: 34 additions & 0 deletions docs/privado-cli/installing-privado-cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
# Installing Privado CLI

To start off, make sure `docker` is installed. To install docker, you can follow the steps stated in the [official documentation](https://docs.docker.com/engine/install/). You can install Privado CLI in multiple manners:

- [Using `curl`](#install-using-curl)
- [Using `go`](#install-using-go)
- [Using releases](#install-release-manually)


## Install using `curl`:
The installation script will download and setup the latest stable release for you as per your OS and arch. Run:

```
curl -o- https://raw.githubusercontent.com/Privado-Inc/privado/main/install.sh | bash
```

To uninstall, simply delete `~/.privado/bin`.

## Install using Go
If you are a GoLang fan, you can use the `go install` command to install the Privado CLI:

```
go install github.com/Privado-Inc/privado@latest
```

This will place the `privado` binary in your `GOPATH`'s bin directory. This directory must be added to the `$PATH` environment variable. You can learn more [here](https://www.digitalocean.com/community/tutorial_series/how-to-install-and-set-up-a-local-programming-environment-for-go).

## Install Release Manually
We use [GitHub Releases](https://github.com/Privado-Inc/privado/releases) to ship versioned `privado` releases for supported platforms. You can download a executable of Privado CLI for your platform.

For example, to setup `privado` for MAC-OSX (arm64), you will download `privado-darwin-amd64.tar.gz`, and run:
```
tar -xf ~/.privado/privado-darwin-amd64.tar.gz
chmod +x privado
mv privado /usr/bin/privado
```


{% hint style="info" %}
Expand Down
4 changes: 1 addition & 3 deletions docs/privado-cli/scan-results.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Scan Results

Once you authenticate, change to the project you want to scan and run command, `privado scan`.
Once you authenticate, run the command, `privado scan <project-dir>`.

CLI image

Expand Down Expand Up @@ -67,5 +67,3 @@ You can remove third parties by marking them as False Positive and give us feedb

\
\


0 comments on commit 327cd53

Please sign in to comment.