Skip to content

Adding new integrations into docs Fixes ENG-830 #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions next.config.js

This file was deleted.

8 changes: 8 additions & 0 deletions next.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import nextra from 'nextra'

const withNextra = nextra({
theme: 'nextra-theme-docs',
themeConfig: './theme.config.jsx'
})

export default withNextra()
5,003 changes: 2,844 additions & 2,159 deletions package-lock.json

Large diffs are not rendered by default.

15 changes: 8 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@
},
"homepage": "https://docs.oneleet.com",
"dependencies": {
"next": "^14.1.1",
"nextra": "^2.13.2",
"nextra-theme-docs": "^2.13.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
"next": "^15.0.2",
"nextra": "^3.2.1",
"nextra-theme-docs": "^3.2.1",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"sharp": "^0.33.5"
},
"devDependencies": {
"@types/node": "18.11.10",
"typescript": "^4.9.3"
"@types/node": "22.9.0",
"typescript": "^5.6.3"
}
}
5 changes: 5 additions & 0 deletions pages/_app.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import type { AppProps } from "next/app";

export default function MyApp({ Component, pageProps }: AppProps) {
return <Component {...pageProps} />;
}
2 changes: 1 addition & 1 deletion pages/_meta.json → pages/_meta.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
export default {
"index": "Introduction",
"integrations": "Integrations",
"oneleet-agent": "Oneleet Agent",
Expand Down
12 changes: 6 additions & 6 deletions pages/guides/1password-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { Steps, Tabs, Tab } from "nextra/components";
import { Steps, Tabs } from "nextra/components";

# 1Password Business Setup

## Set up a 1Password Business Account

<Steps>
### Create 1Password Business Account

Head to [https://start.1password.com/sign-up/plan](https://start.1password.com/sign-up/plan) and select **Business Account**
![](/1password/1Password.png)

Expand All @@ -25,7 +26,6 @@ Generate a secret key and tore this in a safe place as it's the only way to acce

You can invite your team members now, or wait until the end of the guide.
![](/1password/1Password-4.png)

</Steps>

## Create 1Password Security Policies
Expand Down Expand Up @@ -83,7 +83,7 @@ First, go to your invitations page by clicking "Invitations" on your right navba
![](/1password/1Password-19.png)

<Tabs items={["Invite by Email", "Invite by Sign-Up Link"]}>
<Tab>
<Tabs.Tab>
First, click on "Invite By email"

![](/1password/1Password-20.png)
Expand All @@ -92,8 +92,8 @@ First, go to your invitations page by clicking "Invitations" on your right navba

![](/1password/1Password-21.png)

</Tab>
<Tab>
</Tabs.Tab>
<Tabs.Tab>
The invite by Sign-Up Link method is the most convinient of all, you'll be allowed to setup some domains your team uses and just share a link! To do so, click in "View Link and Options" under the Sign-Up Link card

![](/1password/1Password-22.png)
Expand All @@ -102,7 +102,7 @@ First, go to your invitations page by clicking "Invitations" on your right navba

![](/1password/1Password-23.png)

</Tab>
</Tabs.Tab>
</Tabs>

Once your teams have registered with their emails, their accounts need to be confirmed by an owner or an administrator of the 1password team. This can be done from the same invitations screen, and is as simple as clicking on the confirm button next to the users email!
Expand Down
6 changes: 3 additions & 3 deletions pages/guides/_meta.json → pages/guides/_meta.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
export default {
"1password-setup": "1Password Business Setup",
"jumpcloud-setup": "JumpCloud MDM Setup",
"hardening-kubernetes": "Hardening Kubernetes"
}
"hardening-kubernetes": "Hardening Kubernetes",
};
6 changes: 0 additions & 6 deletions pages/integrations/_meta.json

This file was deleted.

14 changes: 14 additions & 0 deletions pages/integrations/_meta.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
export default {
aws: "AWS",
azure: "Azure",
cloudflare: "Cloudflare",
gitlab: "Gitlab",
github: "GitHub",
"google-cloud-platform": "Google Cloud Platform",
"google-workspace": "Google Workspace",
jumpcloud: "Jumpcloud",
mezmo: "Mezmo",
microsoft365: "Microsoft 365",
supabase: "Supabase",
vercel: "Vercel",
};
File renamed without changes.
3 changes: 0 additions & 3 deletions pages/integrations/aws/_meta.json

This file was deleted.

13 changes: 13 additions & 0 deletions pages/integrations/azure.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Microsoft Azure

## Setup

To setup the Azure integration, navigate to the **Integrations > Add integration > Microsoft Azure** and click **Continue**.

Oneleet uses Microsoft Entra ID and Azure Resource Manager to monitor your cloud resource compliance.

Please ensure the following are true before proceeding:
- You are an administrator of your Microsoft Azure account
- You have access to the Azure Portal

Click the 'Connect' button to sign in with your Microsoft account.
14 changes: 14 additions & 0 deletions pages/integrations/cloudflare.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Cloudflare

## Setup
To setup the Cloudflare integration, navigate to the **Integrations > Add integration > Cloudflare** and click **Continue**.

Oneleet utilizes [Cloudflare API tokens](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/) to retreieve Cloudflare assets

1. [Open the Cloudflare dashboard menu for API tokens](https://dash.cloudflare.com/profile/api-tokens/)
2. Select `Create Token`
3. Select the `Read All Resources` template from the available token templates
4. Edit the token name to your liking, a name like `"Oneleet Read-only"` works
5. Scroll to the bottom, select `Continue to summary`
6. Select `Create Token` to generate the token’s secret
7. Copy the secret to the form on the Cloudflare integration setup page.
File renamed without changes.
3 changes: 0 additions & 3 deletions pages/integrations/github/_meta.json

This file was deleted.

12 changes: 12 additions & 0 deletions pages/integrations/gitlab.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Gitlab

## Setup
To setup the GitLab integration, navigate to the **Integrations > Add integration > GitLab** and click **Continue**.

An API key is required for the platform to access GitLab projects and group information. The following steps outline the process of creating a [Group Access Token](https://docs.gitlab.com/ee/user/group/settings/group_access_tokens.html) for the company's root level group.
1. On GitLab open the left sidebar, select **Search or go to** and find your company's root level group.
2. Select Settings > Access Tokens, select Add new token.
3. Enter a name and expiry date for the token.
4. Select the **Reporter** role for the token.
5. Select the **read_api** scope.
6. Select Create group access token.
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
# Google Cloud VPC Setup
# Google Cloud Platform

## What is a VPC?
## Setup
To setup the GCP integration, navigate to the **Integrations > Add integration > Google Cloud Platform** and click **Continue**.


## Google Cloud VPC Setup

### What is a VPC?
Virtual Private Clouds are virtual networks in GCP. They're most commonly used to allow services to communicate with each other. VPCs allow you to control access to services and resources you host on GCP, and the firewall and routing systems prevent unauthorized network access.

## Basic VPC Setup Guide
### Basic VPC Setup Guide


1. Open the [Google Cloud Console](https://console.cloud.google.com/welcome).
Expand Down
4 changes: 0 additions & 4 deletions pages/integrations/google-cloud-platform/_meta.json

This file was deleted.

This file was deleted.

34 changes: 34 additions & 0 deletions pages/integrations/google-workspace.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Google Workspace

## Setup

To setup the Google Workspace integration, navigate to the **Integrations > Add integration > Google Workspace** and click **Continue**.

### Which permissions does Oneleet require?

Oneleet currently requests the following read-only permissions within Google Workspace:
- View audit reports
- View domains
- View user information

### Which resources does Oneleet monitor?

Oneleet currently monitors the following on Google Workspace:
- User accounts
- GMail settings

### Troubleshooting Connection Issues

If you are experiencing difficulties connecting Oneleet to Google Workspace due to sign-in restrictions imposed by your security policies, you will need to manually configure an exemption for Oneleet. This involves using a special identifier known as an OAuth Client ID to bypass certain API security policies and set the Oneleet Google application as a trusted app. Follow these steps to resolve the connection issues:

1. Open your Google Admin console at [https://admin.google.com/](https://admin.google.com/).
2. In the sidebar, navigate to **Security** > **Access and data control** > **API controls**.
3. Click on **Manage third-party app access**.
4. Select **Add app**, then choose **OAuth App Name or Client ID**.
5. Enter the client ID `487371732991-7o3p4g81rmvdj7vj8sh9kh4rqfk5hhgc.apps.googleusercontent.com` and search.
6. Select the Oneleet application from the search results (there should only be one listed).
7. Choose the users or groups you would like to allow to log in to Oneleet's integration.
8. Set the application status to **Trusted** and select **Allowlist for exemption from API access blocks**.
9. Click **Finish** to complete the setup.

By following these steps, you should be able to successfully connect Oneleet to your Google Workspace.
3 changes: 0 additions & 3 deletions pages/integrations/google-workspace/_meta.json

This file was deleted.

20 changes: 0 additions & 20 deletions pages/integrations/google-workspace/google-workspace.mdx

This file was deleted.

6 changes: 6 additions & 0 deletions pages/integrations/jumpcloud.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Jumpcloud

## Setup
To setup the Jumpcloud integration, navigate to the **Integrations > Add integration > Jumpcloud** and click **Continue**.

Oneleet needs an API key from your Jumpcloud account in order to read devices and policies. From the Jumpcloud console, you can find your API key by navigating to your profile icon in the top right, and clicking **My API Key**.
11 changes: 11 additions & 0 deletions pages/integrations/mezmo.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Mezmo

## Setup
To setup the Mezmo integration, navigate to the **Integrations > Add integration > Mezmo** and click **Continue**.

Oneleet uses Mezmo's [Service Keys](https://docs.mezmo.com/docs/ingestion-key#service-keys) to access your Mezmo information.

1. Log in to the [Mezmo Web App](https://app.logdna.com/account/signin)
2. In the left sidebar click the `Settings` gear > `Organization` > `API Keys`
3. Under `Analysis Service Keys` click `Generate Service Key`
4. Copy your key's name and `Service Key` to the form at the bottom of this page.
12 changes: 12 additions & 0 deletions pages/integrations/microsoft365.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Microsoft 365

## Setup
To setup the Microsoft 365 integration, navigate to the **Integrations > Add integration > Microsoft 365** and click **Continue**.

Oneleet uses Microsoft Entra ID and the Microsoft Graph API to query for your cloud resources.

Please ensure the following are true before proceeding:
- You are an administrator of your Microsoft organization.
- You have access to the Microsoft 365 Admin Center.

Click the 'Connect' button to sign in with your Microsoft account.
8 changes: 8 additions & 0 deletions pages/integrations/supabase.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Supabase

## Setup
To setup the Supabase integration, navigate to the **Integrations > Add integration > Supabase** and click **Continue**.

Oneleet uses the Supabase Management API to monitor your resources.

Please make sure that you have administrator access to connect your Supabase account.
18 changes: 18 additions & 0 deletions pages/integrations/vercel.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Vercel

## Setup
To setup the Vercel integration, navigate to the **Integrations > Add integration > Vercel** and click **Continue**.

Oneleet requires an API key to access your Vercel team. We'll walk you through the process of creating a [Vercel API Token](https://vercel.com/docs/rest-api#creating-an-access-token) for your company's Vercel account.
### Creating an Access Token
Access Tokens can be created and managed from inside your [account settings](https://vercel.com/account/tokens).
![](https://vercel.com/_next/image?url=https%3A%2F%2Fassets.vercel.com%2Fimage%2Fupload%2Fv1701697369%2Fdocs-assets%2Fstatic%2Fdocs%2Frest-api%2Fcreate-token-dark.png&w=1920&q=75&dpl=dpl_5UjKAnkcQUrtRFNG25HTUhTVZpCS)
1. In the upper-right corner of your [dashboard](https://vercel.com/dashboard), click your profile picture, then select **Settings**
2. Select **Tokens** from the sidebar
3. Enter a descriptive name for the token
4. Choose the scope from the list of Teams in the drop-down menu. The scope ensures that only your specific Team can use an Access Token
5. From the **Expiration** drop-down, choose "No Expiration" to create a token that never expires
6. Click **Create Token**
7. Once you've created an Access Token, securely store the value as it will not be shown again.
### Vercel Team ID
Go to your Vercel team's settings to find your team ID.
6 changes: 0 additions & 6 deletions pages/oneleet-agent/_meta.json

This file was deleted.

6 changes: 6 additions & 0 deletions pages/oneleet-agent/_meta.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
export default {
setup: "Setup",
macos: "macOS Devices",
windows: "Windows Devices",
linux: "Linux Devices",
};
Loading
Loading