Skip to content

Commit

Permalink
docs: update bearer cloud doc (#1377)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmontard authored Nov 7, 2023
1 parent 996e988 commit 5bf3330
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 29 deletions.
Binary file added docs/assets/img/cloud/setup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ layout: "layouts/doc"
permalink: "/"
---

{% callout "info" %}🎉 Bearer Cloud is available now for free for everyone, <a href="/guides/bearer-cloud">learn more</a>.{% endcallout %}
{% callout "info" %}Discover <a href="/guides/bearer-cloud">Bearer Cloud</a>, our solution to manage product and application code security at scale.{% endcallout %}

# Bearer CLI

Expand Down
48 changes: 20 additions & 28 deletions docs/guides/bearer-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,29 @@ title: Using Bearer Cloud

# Bearer Cloud

If you're looking to manage product and application code security at scale, Bearer Cloud offers a platform for teams that syncs with Bearer CLI's output.
If you're looking to manage product and application code security at scale, Bearer Cloud offers a platform for engineering and security teams that syncs with Bearer CLI's engine.

<iframe class="w-full aspect-video" src="https://youtube.com/embed/whPRe9GaY7w" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

[Learn more about Bearer Cloud](https://www.bearer.com/bearer-cloud).

# Create an account
## Get started with Bearer Cloud

You can [start creating your free account](https://my.bearer.sh/users/sign_up) right now using your GitHub, GitLab, or Google SSO.
We provide many options for you to configure Bearer Cloud with your projects, more information below.
![View Jira Ticket](/assets/img/cloud/setup.png)

{% callout "info" %}
Bearer Cloud free plan comes with these limits:<br/>
- 1 team member<br/>
- 10 applications<br/>
- Slack integration only<br/>

Need more? <a href="https://www.bearer.com/contact">Contact us</a>.
{% endcallout %}
### GitHub App

The easiest way to start with Bearer Cloud, is to use Bearer's GitHub App which allows you to configure your project in 1-click.

# Get started with Bearer Cloud
Here is what happens behind the scenes:
- A GitHub Action is automatically configured on your project, it will trigger scans on PR and on merge to your main branch. You can tweak the configuration however you want afterward.
- A Bearer Cloud API Key is generated and configured on your GitHub project so that scan results are securely sent to your Bearer Cloud Dashboard.

The best part? Bearer does all this without ever having access to your source code beyond the *.github/workflows* directory, where the GitHub Action is configured.

## Generate an API token

To connect Bearer CLI to Bearer Cloud, you'll first need to generate an API token. [Log in to Bearer Cloud](https://my.bearer.sh) and navigate to *Settings > API tokens* by selecting your user account in the top right corner, or from the link in the "Add a project" form.

![API token settings page](/assets/img/api-token.jpg)

## Add the API token to Bearer CLI

Use the API token any place where you run a scan.

### Local projects

Use the `--api-key` flag with the `scan` command:

```bash
bearer scan project-folder --api-key=XXXXXXXX
```
In addition to a 1-click setup, **the GitHub App provides the best developer experience** thanks to the ability for them to ignore findings directly in the PR workflow, and for your Security team to review those in Bearer Cloud Dashboard.

### GitHub Action

Expand All @@ -61,6 +44,14 @@ Set up the [GitLab CI/CD configuration](/guides/gitlab), then adjust your settin

We recommend using [GitLab's CI/CD variables](https://docs.gitlab.com/ee/ci/variables/) to protect your token. In the example above, the variable is named `BEARER_TOKEN`.

### Local projects

Use the `--api-key` flag with the `scan` command:

```bash
bearer scan project-folder --api-key=XXXXXXXX
```

## Import your projects

Bearer Cloud automatically captures any scans run with a valid `api-key`. Subsequent scans of the same project will update the existing project entry in the Bearer Cloud dashboard.
Expand Down Expand Up @@ -121,3 +112,4 @@ Below an example of a Slack notification triggered by a new finding:
## Need help?

Get in touch with our team directly on [Discord](https://discord.com/invite/eaHZBJUXRF) or [book a demo](https://www.bearer.com/demo) with one of our engineer.

0 comments on commit 5bf3330

Please sign in to comment.