Setup - Repository (limited beta)

Note

Fugue’s infrastructure as code (IaC) security features for repository environments are now available in closed beta. Fugue IaC security integrates with Regula to scan code files locally and in CI/CD pipelines. To request access, contact support@fugue.co.

Note

Looking for Azure setup instructions? To get started with Fugue on Microsoft Azure, see Setup - Azure & Azure Government.

Looking for Amazon Web Services instructions? To get started with Fugue on AWS, see Setup - AWS & AWS GovCloud.

Looking for Google setup instructions? To get started with Fugue on Google Cloud Platform, see Setup - Google Cloud.

Ready to create a Fugue environment? An environment contains resources from a single AWS account, Azure subscription, Google project, or code repository – in this case, repository.

_images/repo-create-environment.gif

Tip

In a hurry? For an even quicker setup guide, see Get Started in 5 Minutes.

To learn more about the basics of using Fugue, see Fugue 101.

Sign Up for Fugue

Before you can create an environment, you’ll need to sign up for a free account with Fugue. (You’ll start off with a free Enterprise trial, which gives you access to all of Fugue’s features; after 30 days, you’ll be transitioned to the free-forever Developer plan if you choose not to upgrade.)

Once you’re all signed up and logged in, select the Define New Environment button:

_images/hello-define-env.png

Step 1: Setup (Name, Provider)

In the first step of creating an environment, you name it and specify your provider – cloud or repository.

  1. Name your environment.

  2. Select Git as the provider.

  3. Select Continue.

_images/step1_repo_create.png

Step 2: Settings

Note

If at any point you want to change something, you can select “Back” at the bottom of the page to return to the previous step, or “Edit” in the sidebar next to the desired step to return to that step.

  1. Enter the Repository URL.

  2. Enter the name of the branch you want to evaluate (e.g., main, develop, etc.)

  3. Select Continue.

_images/step_2_repo.png

Step 3: Compliance

Note

Repository environments currently utilize compliance settings that are configured locally with Regula. In a subsequent release, users will be able to manage compliance settings with the Fugue SaaS UI, API, and CLI.

Step 4: Review

  1. Review the details for your environment, including environment name, URL, and branch name.

  2. If anything needs to be changed, click Edit next to the appropriate step.

  3. If everything looks good, select the Create Environment button. Your environment is successfully created and you need to manually kick off a scan to see how your repository looks. See Step 5: Kicking off a Scan for more information.

_images/step_3_repo.png

Step 5: Kicking off a Scan

After creating your repository environment, kick off a scan to evaluate your repository.

  1. Install the beta binary version of Regula. Reach out to support@fugue.co to gain access. If you already have Regula installed, skip to step 2.

    1. Follow steps 2-5 in the Regula docs to install Regula.

  2. Set environment variables FUGUE_API_ID and FUGUE_API_SECRET:

export FUGUE_API_ID=61ae1bed-1b6f-1234-5678-1a2b3c4d5e6f
export FUGUE_API_SECRET=f7a89ac99cab9dd2948712345678901234567890

3. cd into your local repository and switch to the branch you specified in Step 2.2.

4. Run the following command to create a Regula configuration file and replace [environment_id] with your environment ID:

regula init --environment-id [environment_id]

5. Run the following command to kick off a scan:

regula scan
_images/kick-off-scan.png

Congratulations! You’ve just kicked off a scan for your repository environment with Fugue.

Note

If you want to kick off a scan for a repository environment, you must follow the steps outlined above. Using the CLI command fugue scan [environment_id] or hitting the /scans endpoint via the API will not trigger a scan for a repository environment.