From 090f6eef7148eb36b5f6a37f496f0bff32c44c14 Mon Sep 17 00:00:00 2001 From: Harsh Shrikant Bhat <90265455+harshsbhat@users.noreply.github.com> Date: Wed, 19 Mar 2025 14:04:53 +0530 Subject: [PATCH] docs: add enterprise hint for all EE features in docs (#5000) Co-authored-by: Johannes --- docs/mint.json | 4 +- .../configuration/auth-sso/azure-ad-oauth.mdx | 4 +- .../configuration/auth-sso/google-oauth.mdx | 4 +- .../auth-sso/open-id-connect.mdx | 4 +- .../configuration/auth-sso/saml-sso.mdx | 2 +- docs/self-hosting/setup/cluster-setup.mdx | 7 +-- docs/self-hosting/setup/kubernetes.mdx | 57 +++++++++---------- .../core-features/email-customization.mdx | 19 +++---- .../core-features/user-management.mdx | 2 +- .../general-features/email-followups.mdx | 2 +- .../multi-language-surveys.mdx | 2 + .../advanced-targeting.mdx | 6 +- .../user-identification.mdx | 4 ++ 13 files changed, 54 insertions(+), 63 deletions(-) diff --git a/docs/mint.json b/docs/mint.json index 132aad2818..7b383535cd 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -116,7 +116,7 @@ ] }, { - "group": "Core Features", + "group": "Platform Features", "pages": [ { "group": "Integrations", @@ -243,8 +243,8 @@ "pages": [ "self-hosting/setup/one-click", "self-hosting/setup/docker", - "self-hosting/setup/cluster-setup", "self-hosting/setup/monitoring", + "self-hosting/setup/cluster-setup", "self-hosting/setup/kubernetes" ] }, diff --git a/docs/self-hosting/configuration/auth-sso/azure-ad-oauth.mdx b/docs/self-hosting/configuration/auth-sso/azure-ad-oauth.mdx index c3bfbafaa1..40285c338f 100644 --- a/docs/self-hosting/configuration/auth-sso/azure-ad-oauth.mdx +++ b/docs/self-hosting/configuration/auth-sso/azure-ad-oauth.mdx @@ -4,9 +4,7 @@ description: "Configure Microsoft Entra ID (Azure AD) OAuth for secure Single Si icon: "microsoft" --- - - Single Sign-On (SSO) functionality, including OAuth integrations with Google, Microsoft Azure AD, and OpenID Connect, requires is part of the [Enterprise Edition](/self-hosting/advanced/license). - +AzureAD OAuth is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license) ### Microsoft Entra ID diff --git a/docs/self-hosting/configuration/auth-sso/google-oauth.mdx b/docs/self-hosting/configuration/auth-sso/google-oauth.mdx index fef8286e28..1d0f05e807 100644 --- a/docs/self-hosting/configuration/auth-sso/google-oauth.mdx +++ b/docs/self-hosting/configuration/auth-sso/google-oauth.mdx @@ -4,9 +4,7 @@ description: "Configure Google OAuth for secure Single Sign-On with your Formbri icon: "google" --- - - Single Sign-On (SSO) functionality, including OAuth integrations with Google, Microsoft Azure AD, and OpenID Connect, requires is part of the [Enterprise Edition](/self-hosting/advanced/license). - +Google OAuth is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license) ### Google OAuth diff --git a/docs/self-hosting/configuration/auth-sso/open-id-connect.mdx b/docs/self-hosting/configuration/auth-sso/open-id-connect.mdx index 0202467879..068e07e051 100644 --- a/docs/self-hosting/configuration/auth-sso/open-id-connect.mdx +++ b/docs/self-hosting/configuration/auth-sso/open-id-connect.mdx @@ -4,9 +4,7 @@ description: "Configure Open ID Connect for secure Single Sign-On with your Form icon: "key" --- - - Single Sign-On (SSO) functionality, including OAuth integrations with Google, Microsoft Azure AD, and OpenID Connect, requires is part of the [Enterprise Edition](/self-hosting/advanced/license). - +OpenID Connect is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license) Integrating your own OIDC (OpenID Connect) instance with your Formbricks instance allows users to log in using their OIDC credentials, ensuring a secure and streamlined user experience. Please follow the steps below to set up OIDC for your Formbricks instance. diff --git a/docs/self-hosting/configuration/auth-sso/saml-sso.mdx b/docs/self-hosting/configuration/auth-sso/saml-sso.mdx index 64ee1355f6..4de35b73cc 100644 --- a/docs/self-hosting/configuration/auth-sso/saml-sso.mdx +++ b/docs/self-hosting/configuration/auth-sso/saml-sso.mdx @@ -4,7 +4,7 @@ icon: "user-shield" description: "Configure SAML Single Sign-On (SSO) for secure enterprise authentication with your Formbricks instance." --- -You require an Enterprise License along with a SAML SSO add-on to avail this feature. +SAML SSO is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license) ## Overview diff --git a/docs/self-hosting/setup/cluster-setup.mdx b/docs/self-hosting/setup/cluster-setup.mdx index a7063dfafa..84d1f7e745 100644 --- a/docs/self-hosting/setup/cluster-setup.mdx +++ b/docs/self-hosting/setup/cluster-setup.mdx @@ -1,14 +1,9 @@ --- title: "Cluster Setup" -description: "How to set up Formbricks in a cluster" +description: "How to set up Formbricks in a High-Availability Cluster" icon: "circle-nodes" --- - - Running Formbricks in a multi-instance cluster configuration is an Enterprise Edition feature and requires - an enterprise license key. - - ## Overview Running Formbricks as a cluster of multiple instances offers several key advantages: diff --git a/docs/self-hosting/setup/kubernetes.mdx b/docs/self-hosting/setup/kubernetes.mdx index 0f4231708f..1b3d337b3f 100644 --- a/docs/self-hosting/setup/kubernetes.mdx +++ b/docs/self-hosting/setup/kubernetes.mdx @@ -4,13 +4,7 @@ description: "Deploy the new Helm chart on a Kubernetes cluster using Helm." icon: "circle-nodes" --- -# **🚀 Kubernetes Deployment Guide** - -This guide explains how to deploy the **Formbricks Helm Chart** on a Kubernetes cluster using Helm. It provides configuration options for **internal** and **external** databases, caching services, and secrets management. - ---- - -## **📌 Prerequisites** +## Prerequisites Ensure you have the following before proceeding: - A running Kubernetes cluster (EKS, GKE, AKS, Minikube, etc.) @@ -22,32 +16,37 @@ Ensure you have the following before proceeding: --- -## **1️⃣ Installation Steps** +## 1. Installation Steps -### **🔹 Step 1: Clone the Helm Chart** + + ```sh git clone https://github.com/formbricks/formbricks cd helm-chart ``` + -### **🔹 Step 2: Install with Default Configuration** + ```sh helm install formbricks ./ -n formbricks --create-namespace ``` By default: -- PostgreSQL and Redis **are deployed within the cluster**. -- Secrets **are dynamically generated** and stored as Kubernetes Secrets. +- PostgreSQL and Redis are deployed within the cluster. +- Secrets are dynamically generated and stored as Kubernetes Secrets. + -### **🔹 Step 3: Install with an Enterprise License** + ```sh helm install formbricks ./ -n formbricks --create-namespace --set enterprise.licenseKey="YOUR_LICENSE_KEY" ``` + + --- -## **2️⃣ Configuring Secrets** +## 2. Configuring Secrets -### **🔹 Using Kubernetes Secrets (Default)** +### Using Kubernetes Secrets (Default) By default, **secrets are stored as Kubernetes Secrets**. The chart automatically generates **random values** for required secrets. @@ -59,7 +58,7 @@ secret: --- -### **🔹 Using External Secrets (AWS Secrets Manager, Vault, etc.)** +### Using External Secrets (AWS Secrets Manager, Vault, etc.) To use an **external secrets manager**, enable `externalSecret` in `values.yaml`: ```yaml secret: @@ -103,7 +102,7 @@ externalSecret: key: "prod/formbricks/secrets" property: ENCRYPTION_KEY ``` -📌 **Ensure ExternalSecrets Operator is installed:** +**Ensure ExternalSecrets Operator is installed:** [https://external-secrets.io/latest/](https://external-secrets.io/latest/) Install with: @@ -113,9 +112,9 @@ helm install formbricks ./ -n formbricks --create-namespace -f values.yaml --- -## **3️⃣ Configuring PostgreSQL and Redis** +## 3. Configuring PostgreSQL and Redis -### **🔹 Using Managed PostgreSQL and Redis** +### Using Managed PostgreSQL and Redis For production, we recommend using **managed database and cache services**. Modify `values.yaml`: @@ -135,7 +134,7 @@ helm install formbricks ./ -n formbricks --create-namespace -f values.yaml --- -### **🔹 Using In-Cluster PostgreSQL and Redis (Default)** +### Using In-Cluster PostgreSQL and Redis (Default) By default, PostgreSQL and Redis are **deployed inside the cluster**. To **ensure in-cluster deployment**, use: @@ -153,25 +152,25 @@ helm install formbricks ./ -n formbricks --create-namespace -f values.yaml --- -## **4️⃣ Upgrading the Deployment** +## 4. Upgrading the Deployment To apply changes: ```sh helm upgrade formbricks ./ -n formbricks ``` -### **🔹 Scaling Resources** +### Scaling Resources ```sh helm upgrade formbricks ./ -n formbricks --set deployment.resources.limits.cpu=2 --set deployment.resources.limits.memory=4Gi ``` -### **🔹 Enabling Autoscaling** +### Enabling Autoscaling ```sh helm upgrade formbricks ./ -n formbricks --set autoscaling.enabled=true --set autoscaling.minReplicas=3 --set autoscaling.maxReplicas=10 ``` --- -## **5️⃣ Key Configuration Values** +## 5. Key Configuration Values | Field | Description | Default Value | |--------------------------------|--------------------------------------|--------------| @@ -185,17 +184,17 @@ helm upgrade formbricks ./ -n formbricks --set autoscaling.enabled=true --se | `redis.externalRedisUrl` | External Redis URL | `""` | | `externalSecret.enabled` | Enable external secrets manager | `false` | -📌 **Refer to the Helm chart repository for full configuration options.** +**Refer to the Helm chart repository for full configuration options.** --- -## **6️⃣ Uninstalling the Deployment** +## 6. Uninstalling the Deployment To remove the deployment: ```sh helm uninstall formbricks -n formbricks ``` -### **Removing Persistent Volumes (PVCs)** +### Removing Persistent Volumes (PVCs) By default, **PVCs are not deleted** with Helm. To manually remove them: ```sh @@ -209,9 +208,9 @@ kubectl delete namespace formbricks --- -## **📢 Additional Notes** +## Additional Notes - **Ingress Setup:** If using an ingress controller, make sure to configure `ingress.enabled: true` in `values.yaml`. - **Environment Variables:** Pass custom environment variables via `envFrom` in `values.yaml`. - **Backup Strategy:** Ensure you have a backup policy for PostgreSQL if running in-cluster. -🚀 **Your Formbricks deployment is now ready!** 🚀 +**Your Formbricks deployment is now ready!** diff --git a/docs/xm-and-surveys/core-features/email-customization.mdx b/docs/xm-and-surveys/core-features/email-customization.mdx index c33037dc0a..c1b6ab473c 100644 --- a/docs/xm-and-surveys/core-features/email-customization.mdx +++ b/docs/xm-and-surveys/core-features/email-customization.mdx @@ -1,17 +1,19 @@ --- -title: "Email Customization" -description: "Customize the email that is sent to your users!" +title: "Email Branding" +description: "Branding the emails that are sent to your respondents." icon: "envelope" --- -Email customization is a white-label feature that allows you to customize the email that is sent to your users. You can upload a logo of your company and use it in the email. +Email branding is a white-label feature that allows you to customize the email that is sent to your users. You can upload a logo of your company and use it in the email. - This feature is a white-label feature. It is only available for users on paid - plans or have an enterprise license. + Email branding is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license). + + Only the Owner and Managers of the organization can modify the logo. + -## How to Upload a Logo +## How to upload a logo 1. Go to the Organization Settings page. 2. You will see a card called **Email Customization** under the **General** section. @@ -29,11 +31,6 @@ You can click on the **Send test email** button to get a test email with the log ![Email Sample](/images/xm-and-surveys/core-features/email-customization/email-sample.webp) - - - Only the owner and managers of the organization can modify the logo. - - ## Use Cases - **White-labeling**: You can use this feature to white-label your emails to your users. diff --git a/docs/xm-and-surveys/core-features/user-management.mdx b/docs/xm-and-surveys/core-features/user-management.mdx index cfbc4555e8..408549605e 100644 --- a/docs/xm-and-surveys/core-features/user-management.mdx +++ b/docs/xm-and-surveys/core-features/user-management.mdx @@ -13,7 +13,7 @@ Learn about the different organization-level and team-level roles and how they a Permissions in Formbricks are broadly handled using organization-level roles, which apply to all teams and projects in the organization. Users on a self-hosting and Enterprise plan, have access to team-level roles, which enable more granular permissions. - Access Roles is a feature of the **Enterprise Edition**. In the **Community Edition** and on the **Free** + Access Roles is a feature of the [Enterprise Edition](/self-hosting/advanced/license). In the **Community Edition** and on the **Free** and **Startup** plan in the Cloud you can invite unlimited organization members as `Owner`. diff --git a/docs/xm-and-surveys/surveys/general-features/email-followups.mdx b/docs/xm-and-surveys/surveys/general-features/email-followups.mdx index 6d124c8eae..c2f32c1949 100644 --- a/docs/xm-and-surveys/surveys/general-features/email-followups.mdx +++ b/docs/xm-and-surveys/surveys/general-features/email-followups.mdx @@ -9,7 +9,7 @@ icon: "envelope" The email followup feature allows survey creators to automatically send customized emails to respondents based on their survey responses or when they reach specific survey endings. This feature is particularly useful for following up with respondents, sending thank you notes, or providing additional information. - Email followups is a paid feature. It is only available for users on paid plans or have an enterprise license. + Email followups is a paid feature. It is only available for users on paid plans or if you have [Enterprise Edition](/self-hosting/advanced/license). ## Key Components diff --git a/docs/xm-and-surveys/surveys/general-features/multi-language-surveys.mdx b/docs/xm-and-surveys/surveys/general-features/multi-language-surveys.mdx index 639a3329dc..9e09c70604 100644 --- a/docs/xm-and-surveys/surveys/general-features/multi-language-surveys.mdx +++ b/docs/xm-and-surveys/surveys/general-features/multi-language-surveys.mdx @@ -4,6 +4,8 @@ description: "Create surveys that support multiple languages using translations. icon: "language" --- +Multi-language surveys are part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license) + How to deliver a specific language depends on the survey type (app or link survey): - App & Website survey: Set a `language` attribute for the user. [Read this guide for App Surveys](#app-surveys-configuration) diff --git a/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx b/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx index 963ccb46a2..e947650524 100644 --- a/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx +++ b/docs/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.mdx @@ -4,9 +4,9 @@ description: "Advanced Targeting allows you to show surveys to a specific segmen icon: "bullseye" --- - - Advanced Targeting is available on paid plans for both Formbricks Cloud and On Premise. - + + In self-hosting instances advanced Targeting is part of the [Enterprise Edition](/self-hosting/advanced/license). + ### When to use Advanced Targeting? diff --git a/docs/xm-and-surveys/surveys/website-app-surveys/user-identification.mdx b/docs/xm-and-surveys/surveys/website-app-surveys/user-identification.mdx index 6f1682a566..fa7bf9e790 100644 --- a/docs/xm-and-surveys/surveys/website-app-surveys/user-identification.mdx +++ b/docs/xm-and-surveys/surveys/website-app-surveys/user-identification.mdx @@ -4,6 +4,10 @@ description: "User Identification helps you to not only segment your users but a icon: "user" --- + + User identification is part of the Formbricks [Enterprise Edition](/self-hosting/advanced/license). + + ### Understanding Identified vs Unidentified Users In Formbricks, understanding the difference between identified and unidentified users is crucial for effective survey segmentation and targeted feedback collection.