diff --git a/docs/assets/img/cloud/setup.png b/docs/assets/img/cloud/setup.png new file mode 100644 index 000000000..87308b8b3 Binary files /dev/null and b/docs/assets/img/cloud/setup.png differ diff --git a/docs/docs.md b/docs/docs.md index 9538b57f0..80fceefad 100644 --- a/docs/docs.md +++ b/docs/docs.md @@ -4,7 +4,7 @@ layout: "layouts/doc" permalink: "/" --- -{% callout "info" %}🎉 Bearer Cloud is available now for free for everyone, learn more.{% endcallout %} +{% callout "info" %}Discover Bearer Cloud, our solution to manage product and application code security at scale.{% endcallout %} # Bearer CLI diff --git a/docs/guides/bearer-cloud.md b/docs/guides/bearer-cloud.md index dc98f6041..6b988be5b 100644 --- a/docs/guides/bearer-cloud.md +++ b/docs/guides/bearer-cloud.md @@ -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. [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:
-- 1 team member
-- 10 applications
-- Slack integration only
-Need more? Contact us. - {% 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 @@ -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. @@ -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. +