diff --git a/docs/docs.json b/docs/docs.json index ea64490532..54402e5d8a 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -98,7 +98,7 @@ ] }, "user-guide/tutorials/prowler-app-rbac", - "user-guide/providers/prowler-app-api-keys", + "user-guide/tutorials/prowler-app-api-keys", "user-guide/tutorials/prowler-app-mute-findings", { "group": "Integrations", diff --git a/docs/getting-started/basic-usage/prowler-mcp.mdx b/docs/getting-started/basic-usage/prowler-mcp.mdx index 90cc3e0e63..5d89756acf 100644 --- a/docs/getting-started/basic-usage/prowler-mcp.mdx +++ b/docs/getting-started/basic-usage/prowler-mcp.mdx @@ -10,7 +10,7 @@ Configure your MCP client to connect to Prowler MCP Server. **Authentication is optional**: Prowler Hub and Prowler Documentation features work without authentication. An API key is only required for Prowler Cloud and Prowler App (Self-Managed) features. -To use Prowler Cloud or Prowler App (Self-Managed) features. To get the API key, please refer to the [API Keys](/user-guide/providers/prowler-app-api-keys) guide. +To use Prowler Cloud or Prowler App (Self-Managed) features. To get the API key, please refer to the [API Keys](/user-guide/tutorials/prowler-app-api-keys) guide. Keep the API key secure. Never share it publicly or commit it to version control. diff --git a/docs/snippets/version-badge.mdx b/docs/snippets/version-badge.mdx new file mode 100644 index 0000000000..7541ff823a --- /dev/null +++ b/docs/snippets/version-badge.mdx @@ -0,0 +1,12 @@ +export const VersionBadge = ({ version }) => { + return ( + +

+ Added in:  + {version} +

+ + + + ); +}; diff --git a/docs/style.css b/docs/style.css new file mode 100644 index 0000000000..3e9bedbc80 --- /dev/null +++ b/docs/style.css @@ -0,0 +1,51 @@ +/* Version Badge Styling */ +.version-badge-container { + display: inline-block; + margin: 0 0 1rem 0; + padding: 0; +} + +.version-badge { + display: inline-flex; + align-items: center; + margin: 0; + padding: 0.375rem 0.75rem; + background: linear-gradient(135deg, #1a1a1a 0%, #000000 100%); + color: #ffffff; + border-radius: 1.25rem; + font-weight: 400; + font-size: 0.875rem; + line-height: 1.25rem; + border: 1px solid rgba(0, 0, 0, 0.15); + box-shadow: none; +} + +.version-badge-label { + font-weight: 400; + opacity: 1; +} + +.version-badge-version { + background: rgba(255, 255, 255, 0.12); + padding: 0.125rem 0.5rem; + border-radius: 0.875rem; + font-family: ui-monospace, SFMono-Regular, 'SF Mono', Menlo, Monaco, 'Cascadia Code', 'Roboto Mono', Consolas, 'Courier New', monospace; + font-weight: 600; + font-size: 0.875rem; + color: #ffffff; + border: none; +} + + +.dark .version-badge { + background: #55B685; + color: #000000; + border: 2px solid rgba(85, 182, 133, 0.3); + box-shadow: none; + } + + .dark .version-badge-version { + background: rgba(0, 0, 0, 0.1); + color: #000000; + border: none; +} diff --git a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx index eb513096a4..e19d416d32 100644 --- a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx +++ b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx @@ -32,7 +32,7 @@ The AWS Organizations Bulk Provisioning tool simplifies multi-account onboarding * ProwlerRole (or custom role) deployed across all target accounts * Prowler API key (from Prowler Cloud or self-hosted Prowler App) * For self-hosted Prowler App, remember to [point to your API base URL](./bulk-provider-provisioning#custom-api-endpoints) - * Learn how to create API keys: [Prowler App API Keys](../providers/prowler-app-api-keys) + * Learn how to create API keys: [Prowler App API Keys](../tutorials/prowler-app-api-keys) ### Deploying ProwlerRole Across AWS Organizations @@ -101,7 +101,7 @@ To create an API key: 4. Provide a descriptive name and optionally set an expiration date 5. Copy the generated API key (it will only be shown once) -For detailed instructions, see: [Prowler App API Keys](../providers/prowler-app-api-keys) +For detailed instructions, see: [Prowler App API Keys](../tutorials/prowler-app-api-keys) ## Basic Usage diff --git a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx index e81e4fae4d..3ad5d9c0d5 100644 --- a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx +++ b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx @@ -28,7 +28,7 @@ The Bulk Provider Provisioning tool automates the creation of cloud providers in * Python 3.7 or higher * Prowler API key (from Prowler Cloud or self-hosted Prowler App) * For self-hosted Prowler App, remember to [point to your API base URL](#custom-api-endpoints) - * Learn how to create API keys: [Prowler App API Keys](../providers/prowler-app-api-keys) + * Learn how to create API keys: [Prowler App API Keys](../tutorials/prowler-app-api-keys) * Authentication credentials for target cloud providers ### Installation @@ -57,7 +57,7 @@ To create an API key: 4. Provide a descriptive name and optionally set an expiration date 5. Copy the generated API key (it will only be shown once) -For detailed instructions, see: [Prowler App API Keys](../providers/prowler-app-api-keys) +For detailed instructions, see: [Prowler App API Keys](../tutorials/prowler-app-api-keys) ## Configuration File Structure diff --git a/docs/user-guide/providers/prowler-app-api-keys.mdx b/docs/user-guide/tutorials/prowler-app-api-keys.mdx similarity index 99% rename from docs/user-guide/providers/prowler-app-api-keys.mdx rename to docs/user-guide/tutorials/prowler-app-api-keys.mdx index f7a656e173..4e51e62bac 100644 --- a/docs/user-guide/providers/prowler-app-api-keys.mdx +++ b/docs/user-guide/tutorials/prowler-app-api-keys.mdx @@ -2,6 +2,10 @@ title: 'API Keys' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + API key authentication in Prowler App provides an alternative to JWT tokens and empowers automation, CI/CD pipelines, and third-party integrations. This guide explains how to create, manage, and safeguard API keys when working with the Prowler API. ## API Key Advantages diff --git a/docs/user-guide/tutorials/prowler-app-jira-integration.mdx b/docs/user-guide/tutorials/prowler-app-jira-integration.mdx index a4eed1e494..19a31347c9 100644 --- a/docs/user-guide/tutorials/prowler-app-jira-integration.mdx +++ b/docs/user-guide/tutorials/prowler-app-jira-integration.mdx @@ -1,6 +1,9 @@ --- title: "Jira Integration" --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + Prowler App enables automatic export of security findings to Jira, providing seamless integration with Atlassian's work item tracking and project management platform. This comprehensive guide demonstrates how to configure and manage Jira integrations to streamline security incident management and enhance team collaboration across security workflows. diff --git a/docs/user-guide/tutorials/prowler-app-lighthouse.mdx b/docs/user-guide/tutorials/prowler-app-lighthouse.mdx index 1ea3da3ac5..abff053dc8 100644 --- a/docs/user-guide/tutorials/prowler-app-lighthouse.mdx +++ b/docs/user-guide/tutorials/prowler-app-lighthouse.mdx @@ -2,6 +2,10 @@ title: 'Prowler Lighthouse AI' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + Prowler Lighthouse AI is a Cloud Security Analyst chatbot that helps you understand, prioritize, and remediate security findings in your cloud environments. It's designed to provide security expertise for teams without dedicated resources, acting as your 24/7 virtual cloud security analyst. Prowler Lighthouse diff --git a/docs/user-guide/tutorials/prowler-app-mute-findings.mdx b/docs/user-guide/tutorials/prowler-app-mute-findings.mdx index 76b85f0e66..9f3bdad640 100644 --- a/docs/user-guide/tutorials/prowler-app-mute-findings.mdx +++ b/docs/user-guide/tutorials/prowler-app-mute-findings.mdx @@ -1,6 +1,9 @@ --- title: 'Mute Findings (Mutelist)' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + Prowler App allows users to mute specific findings to focus on the most critical security issues. This comprehensive guide demonstrates how to effectively use the Mutelist feature to manage and prioritize security findings. diff --git a/docs/user-guide/tutorials/prowler-app-rbac.mdx b/docs/user-guide/tutorials/prowler-app-rbac.mdx index 8accc77488..72059436f5 100644 --- a/docs/user-guide/tutorials/prowler-app-rbac.mdx +++ b/docs/user-guide/tutorials/prowler-app-rbac.mdx @@ -2,6 +2,10 @@ title: 'Managing Users and Role-Based Access Control (RBAC)' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + **Prowler App** supports multiple users within a single tenant, enabling seamless collaboration by allowing team members to easily share insights and manage security findings. [Roles](#roles) help you control user permissions, determining what actions each user can perform and the data they can access within Prowler. By default, each account includes an immutable **admin** role, ensuring that your account always retains administrative access. diff --git a/docs/user-guide/tutorials/prowler-app-s3-integration.mdx b/docs/user-guide/tutorials/prowler-app-s3-integration.mdx index 8e8158b0c0..728e4a4354 100644 --- a/docs/user-guide/tutorials/prowler-app-s3-integration.mdx +++ b/docs/user-guide/tutorials/prowler-app-s3-integration.mdx @@ -2,6 +2,10 @@ title: 'Amazon S3 Integration' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + **Prowler App** allows automatic export of scan results to Amazon S3 buckets, providing seamless integration with existing data workflows and storage infrastructure. This comprehensive guide demonstrates configuration and management of Amazon S3 integrations to streamline security finding management and reporting. When enabled and configured, scan results are automatically stored in the configured bucket. Results are provided in `csv`, `html` and `json-ocsf` formats, offering flexibility for custom integrations: diff --git a/docs/user-guide/tutorials/prowler-app-security-hub-integration.mdx b/docs/user-guide/tutorials/prowler-app-security-hub-integration.mdx index 4c192e7a0c..592ff2b26d 100644 --- a/docs/user-guide/tutorials/prowler-app-security-hub-integration.mdx +++ b/docs/user-guide/tutorials/prowler-app-security-hub-integration.mdx @@ -1,6 +1,9 @@ --- title: "AWS Security Hub Integration" --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + Prowler App enables automatic export of security findings to AWS Security Hub, providing seamless integration with AWS's native security and compliance service. This comprehensive guide demonstrates how to configure and manage AWS Security Hub integrations to centralize security findings and enhance compliance tracking across AWS environments. diff --git a/docs/user-guide/tutorials/prowler-app-social-login.mdx b/docs/user-guide/tutorials/prowler-app-social-login.mdx index ecc75959e9..45fe8ec62f 100644 --- a/docs/user-guide/tutorials/prowler-app-social-login.mdx +++ b/docs/user-guide/tutorials/prowler-app-social-login.mdx @@ -2,6 +2,10 @@ title: 'Social Login Configuration' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + **Prowler App** supports social login using Google and GitHub OAuth providers. This document guides you through configuring the required environment variables to enable social authentication. Social login buttons diff --git a/docs/user-guide/tutorials/prowler-app-sso.mdx b/docs/user-guide/tutorials/prowler-app-sso.mdx index b22ae7941a..f56336f415 100644 --- a/docs/user-guide/tutorials/prowler-app-sso.mdx +++ b/docs/user-guide/tutorials/prowler-app-sso.mdx @@ -2,6 +2,10 @@ title: 'SAML Single Sign-On (SSO)' --- +import { VersionBadge } from "/snippets/version-badge.mdx" + + + This guide provides comprehensive instructions to configure SAML-based Single Sign-On (SSO) in Prowler App. This configuration allows users to authenticate using the organization's Identity Provider (IdP). This document is divided into two main sections: diff --git a/util/prowler-bulk-provisioning/README.md b/util/prowler-bulk-provisioning/README.md index 4cdb020e21..544862b6c1 100644 --- a/util/prowler-bulk-provisioning/README.md +++ b/util/prowler-bulk-provisioning/README.md @@ -58,7 +58,7 @@ This two-step approach follows the Prowler API design where providers and their export PROWLER_API_KEY="pk_example-api-key" ``` - For detailed instructions on creating API keys, see: https://docs.prowler.com/user-guide/providers/prowler-app-api-keys + For detailed instructions on creating API keys, see: https://docs.prowler.com/user-guide/tutorials/prowler-app-api-keys ## AWS Organizations Integration