mirror of
https://github.com/formbricks/formbricks.git
synced 2025-12-16 12:14:34 -06:00
docs: move community from Discord to Github Discussions (#4365)
This commit is contained in:
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
2
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
@@ -29,4 +29,4 @@ body:
|
||||
### Additional resources 🤓
|
||||
|
||||
- Check out our [Contributor Docs](https://formbricks.com/docs/developer-docs/contributing/get-started)
|
||||
- Anything unclear? [Ask in Discord](https://formbricks.com/discord)
|
||||
- Anything unclear? [Ask in Github Discussions](https://github.com/formbricks/formbricks/discussions)
|
||||
|
||||
@@ -22,6 +22,6 @@ jobs:
|
||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
pr-message: |-
|
||||
Thank you so much for making your first Pull Request and taking the time to improve Formbricks! 🚀🙏❤️
|
||||
Feel free to join the conversation at [Discord](https://formbricks.com/discord)
|
||||
Feel free to join the conversation on [Github Discussions](https://github.com/formbricks/formbricks/discussions) if you need any help or have any questions. 😊
|
||||
issue-message: |
|
||||
Thank you for opening your first issue! 🙏❤️ One of our team members will review it and get back to you as soon as it possible. 😊
|
||||
|
||||
@@ -24,7 +24,7 @@ Ready to dive into the code and make a real impact? Here's your path:
|
||||
|
||||
1. **Pull Request Act:** If you're ready to go, craft a new pull request closely following our PR template 🙏
|
||||
|
||||
Would you prefer a chat before you dive into a lot of work? Our [Discord server](https://formbricks.com/discord) is your harbor. Share your thoughts, and we'll meet you there with open arms. We're responsive and friendly, promise!
|
||||
Would you prefer a chat before you dive into a lot of work? [Github Discussions](https://github.com/formbricks/formbricks/discussions) is your harbor. Share your thoughts, and we'll meet you there with open arms. We're responsive and friendly, promise!
|
||||
|
||||
## 🚀 Aspiring Features
|
||||
|
||||
|
||||
@@ -15,12 +15,12 @@
|
||||
<p align="center">
|
||||
Harvest user-insights, build irresistible experiences.
|
||||
<br />
|
||||
<a href="https://formbricks.com/">Website</a> | <a href="https://formbricks.com/discord">Join Discord community</a>
|
||||
<a href="https://formbricks.com/">Website</a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/formbricks/formbricks/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-AGPL-purple" alt="License"></a> <a href="https://formbricks.com/discord"><img src="https://img.shields.io/discord/979077669410979880?label=Discord&logo=discord&logoColor=%23fff" alt="Join Formbricks Discord"></a> <a href="https://github.com/formbricks/formbricks/stargazers"><img src="https://img.shields.io/github/stars/formbricks/formbricks?logo=github" alt="Github Stars"></a>
|
||||
<a href="https://github.com/formbricks/formbricks/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-AGPL-purple" alt="License"></a> <a href="https://github.com/formbricks/formbricks/stargazers"><img src="https://img.shields.io/github/stars/formbricks/formbricks?logo=github" alt="Github Stars"></a>
|
||||
<a href="https://news.ycombinator.com/item?id=32303986"><img src="https://img.shields.io/badge/Hacker%20News-122-%23FF6600" alt="Hacker News"></a>
|
||||
<a href="[https://www.producthunt.com/products/formbricks](https://www.producthunt.com/posts/formbricks)"><img src="https://img.shields.io/badge/Product%20Hunt-455-orange?logo=producthunt&logoColor=%23fff" alt="Product Hunt"></a>
|
||||
<a href="https://github.blog/2023-04-12-github-accelerator-our-first-cohort-and-whats-next/"><img src="https://img.shields.io/badge/2023-blue?logo=github&label=Github%20Accelerator" alt="Github Accelerator"></a>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# Security Policy of Formbricks
|
||||
|
||||
This is Formbrick's security policy. Please reach out to us
|
||||
on our Discord or, if privately, via <security@formbricks.com>
|
||||
on Github or, if privately, via <security@formbricks.com>
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -40,7 +40,7 @@ We invite you to report if:
|
||||
|
||||
Avoid reporting if:
|
||||
|
||||
- Assistance is needed to optimize Formbricks for security – please engage on our Discord for this.
|
||||
- Assistance is needed to optimize Formbricks for security – please engage on Github Discussions for this.
|
||||
- Help is required for applying security-related updates.
|
||||
- The concern is not related to security.
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ export const metadata = {
|
||||
# Framework Guides
|
||||
|
||||
One can integrate Formbricks App Survey SDK into their app using multiple options! Checkout the options below that we provide! If you are looking
|
||||
for something else, please [join our Discord!](https://formbricks.com/discord) and we would be glad to help.
|
||||
for something else, please [open a new Github Discussion](https://github.com/formbricks/formbricks/discussions) and we would be glad to help.
|
||||
|
||||
<Libraries />
|
||||
|
||||
@@ -448,6 +448,6 @@ Debug log messages provide insights into:
|
||||
- Event tracking, survey triggers and form interactions.
|
||||
- Initialization errors.
|
||||
|
||||
**Can’t figure it out? [Join our Discord!](https://formbricks.com/discord)**
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
---
|
||||
|
||||
@@ -112,4 +112,4 @@ Pick the Survey Type as **App Survey**.
|
||||
- We offer framework guides for various frontend tech, head over to the the [App Survey Framework Guides](/app-surveys/framework-guides) to get started with your app survey.
|
||||
- Head over to our JS SDK documentation to get started with the [JS SDK](/developer-docs/js-sdk).
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join us in Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -102,4 +102,4 @@ For specific surveys, you may need to override the default waiting time. Below i
|
||||
|
||||
---
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join us in Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -438,4 +438,4 @@ And lastly, in the `updateFeedback` function
|
||||
|
||||
Something doesn’t work? Check your browser console for the error.
|
||||
|
||||
Can’t figure it out? [Join our Discord!](https://formbricks.com/discord)
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -226,4 +226,4 @@ Promise<fileUrl>
|
||||
|
||||
---
|
||||
|
||||
If you have any questions or need help, feel free to reach out to us on our **[Discord](https://formbricks.com/discord)**
|
||||
If you have any questions or need help, feel free to reach out to us in **[Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -1,15 +1,13 @@
|
||||
import { MdxImage } from "@/components/MdxImage";
|
||||
|
||||
|
||||
import GithubCodespaceLoading from "./images/loading.webp";
|
||||
import GithubCodespaceNew from "./images/new.webp";
|
||||
import GithubCodespacePorts from "./images/ports.webp";
|
||||
|
||||
|
||||
export const metadata = {
|
||||
title: "Formbricks Open Source Contribution Guide: How to Enhance yourself and Contribute to Formbricks",
|
||||
description:
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Discord",
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Github Discussions",
|
||||
};
|
||||
|
||||
#### Contributing
|
||||
@@ -63,4 +61,4 @@ export const metadata = {
|
||||
className="max-w-full rounded-lg sm:max-w-3xl"
|
||||
/>
|
||||
|
||||
Now make the changes you want to and see them live in action!
|
||||
Now make the changes you want to and see them live in action!
|
||||
|
||||
@@ -3,7 +3,7 @@ import { MdxImage } from "@/components/MdxImage";
|
||||
export const metadata = {
|
||||
title: "Formbricks Open Source Contribution Guide: How to Enhance yourself and Contribute to Formbricks",
|
||||
description:
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Discord",
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Github Discussions",
|
||||
};
|
||||
|
||||
#### Contributing
|
||||
@@ -18,7 +18,7 @@ We are so happy that you are interested in contributing to Formbricks 🤗 There
|
||||
|
||||
## Talk to us first
|
||||
|
||||
We highly recommend connecting with us on [Discord server](https://formbricks.com/discord) before you ship a contribution. This will increase the likelihood of your PR being merged. And it will decrease the likelihood of you wasting your time :)
|
||||
We highly recommend connecting with us on [Github Discussions](https://github.com/formbricks/formbricks/discussions) before you ship a contribution. This will increase the likelihood of your PR being merged. And it will decrease the likelihood of you wasting your time :)
|
||||
|
||||
## Contributor License Agreement (CLA)
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ import UncaughtPromise from "./images/uncaught-promise.webp";
|
||||
export const metadata = {
|
||||
title: "Formbricks Open Source Contribution Guide: How to Enhance yourself and Contribute to Formbricks",
|
||||
description:
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Discord",
|
||||
"Join the Formbricks community and learn how to effectively contribute. From raising issues and feature requests to creating PRs, discover the best practices and communicate with our responsive team on Github Discussions",
|
||||
};
|
||||
|
||||
#### Contributing
|
||||
|
||||
@@ -24,7 +24,8 @@ export const metadata = {
|
||||
The Airtable integration allows you to automatically send responses to an Airtable of your choice.
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow
|
||||
the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
</Note>
|
||||
|
||||
## Formbricks Cloud
|
||||
@@ -101,7 +102,7 @@ Before the next step, make sure that you have a Formbricks Survey with at least
|
||||
|
||||
Congratulations! You have successfully linked an Airtable with Formbricks. Now whenever a response is submitted for the linked survey, it will be automatically added to the linked Airtable.
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join us on Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
## Remove Integration with Airtable
|
||||
|
||||
@@ -124,4 +125,4 @@ To remove the integration with Airtable,
|
||||
with us!
|
||||
</Note>
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -120,4 +120,4 @@ For the above, we ask for:
|
||||
|
||||
<Note>We store as little personal information as possible.</Note>
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -21,7 +21,8 @@ export const metadata = {
|
||||
The notion integration allows you to automatically send responses to a Notion database of your choice.
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure this integration separately. Please follow
|
||||
the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
</Note>
|
||||
|
||||
## Formbricks Cloud
|
||||
@@ -123,4 +124,4 @@ To remove the integration with Slack Workspace,
|
||||
className="max-w-full rounded-lg sm:max-w-3xl"
|
||||
/>
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -10,7 +10,8 @@ export const metadata = {
|
||||
At Formbricks, we understand the importance of integrating with third-party applications. We have step-by-step guides to configure our third-party integrations with a your Formbricks instance. We currently support the below integrations, click on them to see their individual guides:
|
||||
|
||||
<Note>
|
||||
If you are on a self-hosted instance, you will need to configure these integrations manually. Please follow the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
If you are on a self-hosted instance, you will need to configure these integrations manually. Please follow
|
||||
the guides [here](/self-hosting/integrations) to configure integrations on your self-hosted instance.
|
||||
</Note>
|
||||
|
||||
- [Airtable](/developer-docs/integrations/airtable): Automatically send responses to an Airtable of your choice.
|
||||
@@ -24,4 +25,4 @@ At Formbricks, we understand the importance of integrating with third-party appl
|
||||
|
||||
---
|
||||
|
||||
If you have any questions or need help with any of the integrations or even want a new integration, please reach out to us on [Discord](https://formbricks.com/discord).
|
||||
If you have any questions or need help with any of the integrations or even want a new integration, please reach out to us on [Github Discussions](https://github.com/formbricks/formbricks/discussions).
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
import { MdxImage } from "@/components/MdxImage";
|
||||
|
||||
import AddSlackBot1 from "./images/add-slack-bot-1.webp";
|
||||
import AddSlackBot2 from "./images/add-slack-bot-2.webp";
|
||||
import AddSlackBot3 from "./images/add-slack-bot-3.webp";
|
||||
import AddSlackBot4 from "./images/add-slack-bot-4.webp";
|
||||
import ConnectWithSlack from "./images/connect-with-slack.webp";
|
||||
import DeleteConnection from "./images/delete-connection.webp";
|
||||
import IntegrationsTab from "./images/integrations-tab.webp";
|
||||
@@ -8,10 +12,7 @@ import LinkWithQuestions from "./images/link-with-questions.webp";
|
||||
import ListLinkedSurveys from "./images/list-linked-surveys.webp";
|
||||
import SlackAuth from "./images/slack-auth.webp";
|
||||
import SlackConnected from "./images/slack-connected.webp";
|
||||
import AddSlackBot1 from "./images/add-slack-bot-1.webp";
|
||||
import AddSlackBot2 from "./images/add-slack-bot-2.webp";
|
||||
import AddSlackBot3 from "./images/add-slack-bot-3.webp";
|
||||
import AddSlackBot4 from "./images/add-slack-bot-4.webp";
|
||||
|
||||
export const metadata = {
|
||||
title: "Slack",
|
||||
description:
|
||||
@@ -75,7 +76,7 @@ The slack integration allows you to automatically send responses to a Slack chan
|
||||
5. In order to make your channel available in channel dropdown, you need to add formbricks integration bot to the channel you want to link. You can do this by going to channel settings -> Integrations -> Add apps -> Search for "Formbricks" -> Select the bot -> Add.
|
||||
|
||||
<MdxImage
|
||||
src={AddSlackBot1}
|
||||
src={AddSlackBot1}
|
||||
alt="Click on three dot at top right of the channel"
|
||||
quality="100"
|
||||
className="max-w-full rounded-lg sm:max-w-3xl"
|
||||
@@ -95,7 +96,7 @@ The slack integration allows you to automatically send responses to a Slack chan
|
||||
<MdxImage
|
||||
src={AddSlackBot4}
|
||||
alt="Add Formbricks Bot"
|
||||
quality="100"
|
||||
quality="100"
|
||||
className="max-w-full rounded-lg sm:max-w-3xl"
|
||||
/>
|
||||
|
||||
@@ -196,4 +197,4 @@ To remove the integration with Slack Workspace,
|
||||
className="max-w-full rounded-lg sm:max-w-3xl"
|
||||
/>
|
||||
|
||||
Still struggling or something not working as expected? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still struggling or something not working as expected? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -128,4 +128,4 @@ You did it! Reload the WordPress page and your survey should appear!
|
||||
|
||||
## Doesn't work?
|
||||
|
||||
Join our [Discord to get help 🤓](https://formbricks.com/discord)
|
||||
If you have any questions or need help, feel free to reach out to us on **[Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -254,4 +254,4 @@ If you see this error in the console, it means that the Formbricks JS package is
|
||||
|
||||
---
|
||||
|
||||
If you are still facing issues, please [Open an Issue on GitHub](https://github.com/formbricks/formbricks/issues) or [join our Discord](https://formbricks.com/discord)! We’re more than happy to help you get started 😊
|
||||
If you have any questions or need help, feel free to reach out to us on **[Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -38,4 +38,4 @@ Learn about Formbricks Webhooks and how to set up event-driven notifications in
|
||||
|
||||
Interested in contributing to the Formbricks ecosystem? This page provides guidance on how to run Formbricks locally, report issues, contribute through code, and collaborate with the Formbricks community to enhance the platform for everyone.
|
||||
|
||||
If you have any questions or need assistance, feel free to reach out to us on [Discord](https://formbricks.com/discord). Happy coding!
|
||||
If you have any questions or need help, feel free to reach out to us on **[Github Discussions](https://github.com/formbricks/formbricks/discussions)**. Happy coding!
|
||||
|
||||
@@ -131,6 +131,6 @@ Hit the below request to verify that you are authenticated with your API Key and
|
||||
</Col>
|
||||
</Row>
|
||||
|
||||
Can’t figure it out? Join our [Discord](https://discord.com/invite/3YFcABF2Ts) and we'd be glad to assist you!
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
---
|
||||
|
||||
@@ -164,4 +164,4 @@ Go back to [app.formbricks.com](http://app.formbricks.com) or your self-hosted i
|
||||
|
||||
---
|
||||
|
||||
If you have any questions or need help, feel free to reach out to us on our **[Discord](https://formbricks.com/discord)**
|
||||
If you have any questions or need help, feel free to reach out to us on **[Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -62,4 +62,4 @@ You can export the metadata of your responses along with the response data. When
|
||||
|
||||
---
|
||||
|
||||
Can’t figure it out? Join our [Discord](https://discord.com/invite/3YFcABF2Ts)!
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -32,9 +32,10 @@ How to deliver a specific language depends on the survey type (app or link surve
|
||||
details on the Formbricks Cloud.
|
||||
</Note>
|
||||
|
||||
|
||||
<ResponsiveVideo title="Formbricks Multi-language Surveys"
|
||||
src="https://www.youtube-nocookie.com/embed/Vol5zjYIoos?si=bdP2y3uk8-xR0uSD&controls=0" />
|
||||
<ResponsiveVideo
|
||||
title="Formbricks Multi-language Surveys"
|
||||
src="https://www.youtube-nocookie.com/embed/Vol5zjYIoos?si=bdP2y3uk8-xR0uSD&controls=0"
|
||||
/>
|
||||
|
||||
---
|
||||
|
||||
@@ -168,4 +169,4 @@ Without the `lang` parameter, Formbricks will show the survey in the default lan
|
||||
|
||||
You can now start collecting responses in multiple languages!
|
||||
|
||||
Can’t figure it out? Join our [Discord](https://discord.com/invite/3YFcABF2Ts)!
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -266,4 +266,4 @@ PS: If you do not see any signature settings, just use one of the methods we've
|
||||
|
||||
---
|
||||
|
||||
**Can’t figure it out?** [Join our Discord!](https://formbricks.com/discord)
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -72,7 +72,7 @@ These variables are present inside your machine’s docker-compose file. Restart
|
||||
| OPENTELEMETRY_LISTENER_URL | URL for OpenTelemetry listener inside Formbricks. | optional | |
|
||||
| CUSTOM_CACHE_DISABLED | Disables custom cache handler if set to 1 (required for deployment on Vercel) | optional | |
|
||||
|
||||
Note: If you want to configure something that is not possible via above, please open an issue on our GitHub repo here or reach out to us on Discord and we’ll try our best to work out a solution with you.
|
||||
Note: If you want to configure something that is not possible via above, please open an issue on our GitHub repo here or reach out to us on Github Discussions and we’ll try our best to work out a solution with you.
|
||||
|
||||
## OAuth Configuration
|
||||
|
||||
|
||||
@@ -228,4 +228,4 @@ To edit any of the available environment variables, check out our [Configure](/s
|
||||
|
||||
</Note>
|
||||
|
||||
Still facing issues? [Join our Discord!](https://formbricks.com/discord) and we'd be glad to assist you!
|
||||
Still facing issues? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) and we'd be glad to assist you!
|
||||
|
||||
@@ -1151,4 +1151,4 @@ x-environment: &environment
|
||||
</CodeGroup>
|
||||
</Col>
|
||||
|
||||
Did we miss something? Are you still facing issues migrating your app? [Join our Discord!](https://formbricks.com/discord) We'd be happy to help!
|
||||
Did we miss something? Are you still facing issues migrating your app? [Join our Github Discussions](https://github.com/formbricks/formbricks/discussions) We'd be happy to help!
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
export const metadata = {
|
||||
title: "Step by Step Guide on Deploying Formbricks to Production on Ubuntu",
|
||||
description:
|
||||
"Master the swift deployment of Formbricks on an Ubuntu server with our step-by-step guide. Use a single command to automate Docker, Postgres DB, SSL certificate configuration, and more. Encounter issues? Dive into our troubleshooting steps or join our community on Discord for assistance.",
|
||||
"Master the swift deployment of Formbricks on an Ubuntu server with our step-by-step guide. Use a single command to automate Docker, Postgres DB, SSL certificate configuration, and more. Encounter issues? Dive into our troubleshooting steps or join our community on Github Discussions for assistance.",
|
||||
};
|
||||
|
||||
#### Self-Hosting
|
||||
|
||||
@@ -12,6 +12,8 @@ Welcome to Formbricks, the versatile surveying tool designed to meet the needs o
|
||||
|
||||
<Note>Running Formbricks requires at least 1 vCPU, 2 GBs of RAM, 8 GBs of SSD</Note>
|
||||
|
||||
<Note>The Formbricks server must be run with a valid HTTPS certificate.</Note>
|
||||
|
||||
This section covers the below:
|
||||
|
||||
- [**One Click Setup**](/self-hosting/one-click): Quickly set up a production instance of Formbricks on Ubuntu with our convenient shell script.
|
||||
@@ -47,4 +49,4 @@ Please note that regardless of the method you choose, Formbricks is designed to
|
||||
|
||||
---
|
||||
|
||||
**Can’t figure it out?**: **[Join our Discord!](https://formbricks.com/discord)**
|
||||
**Can’t figure it out?**: **[Get help in Github Discussions](https://github.com/formbricks/formbricks/discussions)**
|
||||
|
||||
@@ -69,7 +69,6 @@ export const Header = forwardRef<React.ElementRef<"div">, { className?: string }
|
||||
<TopLevelNavItem href="https://github.com/formbricks/formbricks">
|
||||
Star us on GitHub
|
||||
</TopLevelNavItem>
|
||||
<TopLevelNavItem href="https://formbricks.com/discord">Join our Discord</TopLevelNavItem>
|
||||
</ul>
|
||||
</nav>
|
||||
<div className="hidden md:block md:h-5 md:w-px md:bg-slate-900/10 md:dark:bg-white/15" />
|
||||
|
||||
@@ -24,7 +24,6 @@ import Image from "next/image";
|
||||
import Link from "next/link";
|
||||
import { useRouter } from "next/navigation";
|
||||
import { useMemo, useState } from "react";
|
||||
import { AiOutlineDiscord } from "react-icons/ai";
|
||||
import { cn } from "@formbricks/lib/cn";
|
||||
import { capitalizeFirstLetter } from "@formbricks/lib/utils/strings";
|
||||
import { TOrganization } from "@formbricks/types/organizations";
|
||||
@@ -60,12 +59,6 @@ export const LandingSidebar = ({
|
||||
target: "_blank",
|
||||
icon: ArrowUpRightIcon,
|
||||
},
|
||||
{
|
||||
label: t("common.join_discord"),
|
||||
href: "https://formbricks.com/discord",
|
||||
target: "_blank",
|
||||
icon: AiOutlineDiscord,
|
||||
},
|
||||
];
|
||||
|
||||
const currentOrganizationId = organization?.id;
|
||||
|
||||
@@ -48,7 +48,6 @@ import Image from "next/image";
|
||||
import Link from "next/link";
|
||||
import { usePathname, useRouter } from "next/navigation";
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { AiOutlineDiscord } from "react-icons/ai";
|
||||
import { cn } from "@formbricks/lib/cn";
|
||||
import { getAccessFlags } from "@formbricks/lib/membership/utils";
|
||||
import { capitalizeFirstLetter } from "@formbricks/lib/utils/strings";
|
||||
@@ -227,12 +226,6 @@ export const MainNavigation = ({
|
||||
target: "_blank",
|
||||
icon: ArrowUpRightIcon,
|
||||
},
|
||||
{
|
||||
label: t("common.join_discord"),
|
||||
href: "https://formbricks.com/discord",
|
||||
target: "_blank",
|
||||
icon: AiOutlineDiscord,
|
||||
},
|
||||
];
|
||||
|
||||
useEffect(() => {
|
||||
|
||||
@@ -99,10 +99,6 @@ if (typeof window !== "undefined") {
|
||||
</li>
|
||||
<li>
|
||||
<span>{t("environments.product.app-connection.not_working")}</span>{" "}
|
||||
<Link className="decoration-brand-dark" href="https://formbricks.com/discord" target="_blank">
|
||||
{t("environments.product.app-connection.join_discord")}
|
||||
</Link>{" "}
|
||||
{t("environments.product.app-connection.or")}{" "}
|
||||
<Link
|
||||
className="decoration-brand-dark"
|
||||
target="_blank"
|
||||
@@ -168,10 +164,6 @@ if (typeof window !== "undefined") {
|
||||
href="https://github.com/formbricks/formbricks/issues">
|
||||
{t("environments.product.app-connection.open_an_issue_on_github")}
|
||||
</Link>{" "}
|
||||
{t("environments.product.app-connection.or")}{" "}
|
||||
<Link className="decoration-brand-dark" href="https://formbricks.com/discord" target="_blank">
|
||||
{t("environments.product.app-connection.join_discord")}
|
||||
</Link>
|
||||
</li>
|
||||
<li>
|
||||
<span className="font-semibold">
|
||||
|
||||
@@ -42,16 +42,6 @@ export function EmailTemplate({ children }): React.JSX.Element {
|
||||
/>
|
||||
</Link>
|
||||
</Column>
|
||||
<Column align="left" key="discord">
|
||||
<Link href="https://formbricks.com/discord" target="_blank">
|
||||
<Img
|
||||
alt="Discord"
|
||||
src="https://s3.eu-central-1.amazonaws.com/listmonk-formbricks/Discord-transp.png"
|
||||
title="Discord"
|
||||
width="32"
|
||||
/>
|
||||
</Link>
|
||||
</Column>
|
||||
</Row>
|
||||
</Section>
|
||||
<Section className="mt-4 text-center">
|
||||
|
||||
@@ -63,7 +63,6 @@
|
||||
"react-dom": "19.0.0-rc-ed15d500-20241110",
|
||||
"react-hook-form": "7.53.0",
|
||||
"react-hot-toast": "2.4.1",
|
||||
"react-icons": "5.3.0",
|
||||
"redis": "4.7.0",
|
||||
"sharp": "0.33.5",
|
||||
"stripe": "16.7.0",
|
||||
|
||||
@@ -13,11 +13,10 @@
|
||||
<p align="center">
|
||||
Harvest user-insights, build irresistible experiences.
|
||||
<br />
|
||||
<a href="https://formbricks.com/">Website</a> | <a href="https://formbricks.com/discord">Join Discord community</a>
|
||||
<a href="https://formbricks.com/">Website</a>
|
||||
</p>
|
||||
</p>
|
||||
|
||||
|
||||
# Formbricks Helm Chart: Comprehensive Documentation
|
||||
|
||||
1. [Introduction](#introduction)
|
||||
@@ -66,6 +65,7 @@ This Helm chart deploys the following components:
|
||||
To quickly deploy Formbricks with default settings:
|
||||
|
||||
1. Add the Formbricks Helm repository:
|
||||
|
||||
```bash
|
||||
helm repo add formbricks https://charts.formbricks.com
|
||||
helm repo update
|
||||
@@ -84,105 +84,107 @@ Here are various examples of how to install and configure the Formbricks Helm ch
|
||||
|
||||
1. **Default Installation with Traefik enabled and Custom Hostname**:
|
||||
|
||||
<details>
|
||||
<details>
|
||||
|
||||
<summary>Option 1: Installation without SSL (Not recommended for production)</summary>
|
||||
<summary>Option 1: Installation without SSL (Not recommended for production)</summary>
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com
|
||||
```
|
||||
|
||||
This command enables Traefik and sets a custom hostname. Replace `forms.example.com` with your actual domain name.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Option 2: Installation with SSL (Recommended for production)</summary>
|
||||
|
||||
1. First, download the values file:
|
||||
|
||||
```bash
|
||||
helm show values formbricks/formbricks > values.yaml
|
||||
```
|
||||
|
||||
2. Open the `values.yaml` file in a text editor and make the following changes:
|
||||
|
||||
```yaml
|
||||
traefik:
|
||||
enabled: true
|
||||
additionalArguments:
|
||||
- "--certificatesresolvers.letsencrypt.acme.email=your-email@example.com"
|
||||
```
|
||||
|
||||
Replace `your-email@example.com` with a valid email address where you want to receive Let's Encrypt notifications.
|
||||
|
||||
3. Install Formbricks with the updated values file:
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
-f values.yaml \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set hostname=forms.example.com
|
||||
```
|
||||
|
||||
This command enables Traefik, sets a custom hostname, and uses the configured email address for Let's Encrypt. Remember to replace `forms.example.com` with your actual domain name.
|
||||
|
||||
</details>
|
||||
|
||||
These installation options provide flexibility in setting up Formbricks with Traefik. The SSL option is recommended for production environments to ensure secure communications.
|
||||
|
||||
2. **Community Advanced:**
|
||||
Provision a whole community setup with Formbricks, Postgres, Custom Domain with SSL
|
||||
|
||||
```bash
|
||||
helm install formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set postgres.enabled=true \
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com \
|
||||
--set email=your-mail@example.com
|
||||
```
|
||||
|
||||
3. **Cluster Advanced:**
|
||||
Provision a ready to use cluster for enterprise customers with Formbricks (3 pods), Postgres, Redis and Custom Domain with SSL
|
||||
|
||||
```bash
|
||||
helm install formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set replicaCount=3
|
||||
--set redis.enabled=true \
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com \
|
||||
--set email=your-mail@example.com
|
||||
```
|
||||
|
||||
4. **Installation with Redis and PostgreSQL Disabled, Using External Services**:
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set postgresql.enabled=false \
|
||||
--set postgresql.externalUrl=postgresql://user:password@your-postgres-url:5432/dbname \
|
||||
--set redis.enabled=false \
|
||||
--set redis.externalUrl=redis://your-redis-url:6379
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com
|
||||
```
|
||||
|
||||
5. **High Availability Setup**:
|
||||
```bash
|
||||
This command enables Traefik and sets a custom hostname. Replace `forms.example.com` with your actual domain name.
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Option 2: Installation with SSL (Recommended for production)</summary>
|
||||
|
||||
1. First, download the values file:
|
||||
|
||||
```bash
|
||||
helm show values formbricks/formbricks > values.yaml
|
||||
```
|
||||
|
||||
2. Open the `values.yaml` file in a text editor and make the following changes:
|
||||
|
||||
```yaml
|
||||
traefik:
|
||||
enabled: true
|
||||
additionalArguments:
|
||||
- "--certificatesresolvers.letsencrypt.acme.email=your-email@example.com"
|
||||
```
|
||||
|
||||
Replace `your-email@example.com` with a valid email address where you want to receive Let's Encrypt notifications.
|
||||
|
||||
3. Install Formbricks with the updated values file:
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
-f values.yaml \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set hostname=forms.example.com
|
||||
```
|
||||
|
||||
This command enables Traefik, sets a custom hostname, and uses the configured email address for Let's Encrypt. Remember to replace `forms.example.com` with your actual domain name.
|
||||
|
||||
</details>
|
||||
|
||||
These installation options provide flexibility in setting up Formbricks with Traefik. The SSL option is recommended for production environments to ensure secure communications.
|
||||
|
||||
2. **Community Advanced:**
|
||||
Provision a whole community setup with Formbricks, Postgres, Custom Domain with SSL
|
||||
|
||||
```bash
|
||||
helm install formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set postgres.enabled=true \
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com \
|
||||
--set email=your-mail@example.com
|
||||
```
|
||||
|
||||
3. **Cluster Advanced:**
|
||||
Provision a ready to use cluster for enterprise customers with Formbricks (3 pods), Postgres, Redis and Custom Domain with SSL
|
||||
|
||||
```bash
|
||||
helm install formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set replicaCount=3
|
||||
--set redis.enabled=true \
|
||||
--set traefik.enabled=true \
|
||||
--set hostname=forms.example.com \
|
||||
--set email=your-mail@example.com
|
||||
```
|
||||
|
||||
4. **Installation with Redis and PostgreSQL Disabled, Using External Services**:
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set postgresql.enabled=false \
|
||||
--set postgresql.externalUrl=postgresql://user:password@your-postgres-url:5432/dbname \
|
||||
--set redis.enabled=false \
|
||||
--set redis.externalUrl=redis://your-redis-url:6379
|
||||
```
|
||||
|
||||
5. **High Availability Setup**:
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
--create-namespace \
|
||||
--set replicaCount=3
|
||||
--set replicaCount=3
|
||||
```
|
||||
|
||||
This command:
|
||||
|
||||
1. Deploys the Formbricks application with 3 replicas.
|
||||
2. Enables PostgreSQL and Redis with default settings.
|
||||
|
||||
@@ -196,6 +198,7 @@ For advanced configuration and scaling of PostgreSQL and Redis, refer to their r
|
||||
These documents provide detailed information on scaling and configuring high availability for each component.
|
||||
|
||||
4. **Custom Configuration with Environment Variables**:
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks \
|
||||
--namespace formbricks \
|
||||
@@ -225,33 +228,35 @@ For detailed configuration options, please refer to the [Full Values Documentati
|
||||
|
||||
Formbricks supports various environment variables for configuration. Here are some key variables:
|
||||
|
||||
| Variable | Description | Required | Default |
|
||||
|----------|-------------|----------|---------|
|
||||
| `WEBAPP_URL` | Base URL of the site | Yes | `http://localhost:3000` |
|
||||
| `NEXTAUTH_URL` | Location of the auth server | Yes | `http://localhost:3000` |
|
||||
| `DATABASE_URL` | Database URL with credentials | Yes | - |
|
||||
| `NEXTAUTH_SECRET` | Secret for NextAuth | Yes | (Generated) |
|
||||
| `ENCRYPTION_KEY` | Secret for data encryption | Yes | (Generated) |
|
||||
| `CRON_SECRET` | API Secret for running cron jobs | Yes | (Generated) |
|
||||
| `...` | ... | ... | ... |
|
||||
| Variable | Description | Required | Default |
|
||||
| ----------------- | -------------------------------- | -------- | ----------------------- |
|
||||
| `WEBAPP_URL` | Base URL of the site | Yes | `http://localhost:3000` |
|
||||
| `NEXTAUTH_URL` | Location of the auth server | Yes | `http://localhost:3000` |
|
||||
| `DATABASE_URL` | Database URL with credentials | Yes | - |
|
||||
| `NEXTAUTH_SECRET` | Secret for NextAuth | Yes | (Generated) |
|
||||
| `ENCRYPTION_KEY` | Secret for data encryption | Yes | (Generated) |
|
||||
| `CRON_SECRET` | API Secret for running cron jobs | Yes | (Generated) |
|
||||
| `...` | ... | ... | ... |
|
||||
|
||||
For a comprehensive list of supported environment variables, refer to the [Formbricks Configuration Documentation](https://formbricks.com/docs/self-hosting/configuration).
|
||||
|
||||
|
||||
## Scaling
|
||||
|
||||
```bash
|
||||
kubectl scale deployment my-formbricks --replicas=5 -n formbricks
|
||||
```
|
||||
|
||||
This command scales the Formbricks deployment to 5 replicas. Replace `my-formbricks` with your actual deployment name if different.
|
||||
|
||||
### With Auto Scaling (Kubernetes Metrics Server Requirement)
|
||||
|
||||
The Formbricks Helm chart includes support for Horizontal Pod Autoscaling (HPA) to automatically adjust the number of pods based on CPU utilization. This feature is enabled by default and can be customized to suit your specific needs.
|
||||
|
||||
```bash
|
||||
helm install my-formbricks formbricks/formbricks --namespace formbricks --create-namespace \
|
||||
--set autoscaling.enabled=true
|
||||
```
|
||||
|
||||
This configuration sets up autoscaling with a minimum of 2 replicas and a maximum of 5 replicas, targeting an average CPU utilization of 80%
|
||||
|
||||
### Customizing Autoscaling
|
||||
@@ -298,7 +303,6 @@ For more detailed information on installing and configuring the Metrics Server,
|
||||
|
||||
The Formbricks Helm chart uses Kubernetes HPA v2, which allows for more advanced scaling behaviors. You can customize the `behavior` section in the `values.yaml` file to fine-tune how your application scales up and down. For more information on advanced HPA configurations, refer to the [Kubernetes HPA documentation](https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/).
|
||||
|
||||
|
||||
## Upgrading Formbricks
|
||||
|
||||
This section provides guidance on how to upgrade your Formbricks deployment using Helm, including examples of common upgrade scenarios.
|
||||
@@ -366,6 +370,7 @@ helm upgrade my-formbricks formbricks/formbricks \
|
||||
|
||||
To update PostgreSQL database credentials:
|
||||
To switch from the built-in PostgreSQL to an external database or update the external database credentials:
|
||||
|
||||
```bash
|
||||
helm upgrade my-formbricks formbricks/formbricks \
|
||||
--set postgresql.enabled=false \
|
||||
@@ -411,68 +416,68 @@ Remember to always backup your data before performing upgrades, especially when
|
||||
## Support
|
||||
|
||||
For support with the Formbricks Helm chart:
|
||||
- Open an issue on the [Formbricks GitHub repository](https://github.com/formbricks/formbricks)
|
||||
- Join our [community Discord](https://discord.com/invite/3YFcABF2Ts)
|
||||
- For enterprise support, contact us at hola@formbricks.com
|
||||
|
||||
- Open an issue on the [Formbricks GitHub repository](https://github.com/formbricks/formbricks)
|
||||
- Get help on [Github Discussions](https://github.com/formbricks/formbricks/discussions)
|
||||
- For enterprise support, contact us at hola@formbricks.com
|
||||
|
||||
## Full Values Documentation
|
||||
|
||||
Below is a comprehensive list of all configurable values in the Formbricks Helm chart:
|
||||
|
||||
| Field | Description | Default |
|
||||
|-------|-------------|---------|
|
||||
| `image.repository` | Docker image repository for Formbricks | `ghcr.io/formbricks/formbricks` |
|
||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||
| `image.tag` | Docker image tag | `"2.6.0"` |
|
||||
| `service.type` | Kubernetes service type | `ClusterIP` |
|
||||
| `service.port` | Kubernetes service port | `80` |
|
||||
| `service.targetPort` | Container port to expose | `3000` |
|
||||
| `resources.limits.cpu` | CPU resource limit | `500m` |
|
||||
| `resources.limits.memory` | Memory resource limit | `1Gi` |
|
||||
| `resources.requests.cpu` | Memory resource request | `null` |
|
||||
| `resources.requests.memory` | Memory resource request | `null` |
|
||||
| `autoscaling.enabled` | Enable autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum number of replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum number of replicas | `5` |
|
||||
| `autoscaling.metrics[0].type` | Type of metric for autoscaling | `Resource` |
|
||||
| `autoscaling.metrics[0].resource.name` | Resource name for autoscaling metric | `cpu` |
|
||||
| `autoscaling.metrics[0].resource.target.type` | Target type for autoscaling | `Utilization` |
|
||||
| `autoscaling.metrics[0].resource.target.averageUtilization` | Average utilization target for autoscaling | `80` |
|
||||
| `autoscaling.behavior.scaleDown.stabilizationWindowSeconds` | Stabilization window for scaling down | `300` |
|
||||
| `autoscaling.behavior.scaleUp.stabilizationWindowSeconds` | Stabilization window for scaling up | `0` |
|
||||
| `replicaCount` | Number of replicas | `1` |
|
||||
| `formbricksConfig.nextAuthSecret` | NextAuth secret | `""` |
|
||||
| `formbricksConfig.encryptionKey` | Encryption key | `""` |
|
||||
| `formbricksConfig.cronSecret` | Cron secret | `""` |
|
||||
| `env` | Additional environment variables | `{}` |
|
||||
| `hostname` | Hostname for Formbricks | `""` |
|
||||
| `traefik.enabled` | Enable Traefik ingress | `false` |
|
||||
| `traefik.ingressRoute.dashboard.enabled` | Enable Traefik dashboard | `false` |
|
||||
| `traefik.additionalArguments` | Additional arguments for Traefik | [See values.yaml] |
|
||||
| `traefik.tls.enabled` | Enable TLS for Traefik | `true` |
|
||||
| `traefik.tls.certResolver` | Cert resolver for Traefik | `letsencrypt` |
|
||||
| `traefik.ports.web.port` | HTTP port for Traefik | `80` |
|
||||
| `traefik.ports.websecure.port` | HTTPS port for Traefik | `443` |
|
||||
| `traefik.persistence.enabled` | Enable persistence for Traefik | `true` |
|
||||
| `traefik.persistence.size` | Size of persistent volume for Traefik | `128Mi` |
|
||||
| `traefik.podSecurityContext.fsGroup` | fsGroup for Traefik pods | `0` |
|
||||
| `traefik.hostNetwork` | Use host network for Traefik | `true` |
|
||||
| `traefik.securityContext` | Security context for Traefik | [See values.yaml] |
|
||||
| `redis.enabled` | Enable Redis | `true` |
|
||||
| `redis.externalUrl` | External Redis URL | `""` |
|
||||
| `redis.architecture` | Redis architecture | `standalone` |
|
||||
| `redis.auth.enabled` | Enable Redis authentication | `true` |
|
||||
| `redis.auth.password` | Redis password | `redispassword` |
|
||||
| `redis.master.persistence.enabled` | Enable persistence for Redis master | `false` |
|
||||
| `redis.replica.replicaCount` | Number of Redis replicas | `0` |
|
||||
| `postgresql.enabled` | Enable PostgreSQL | `true` |
|
||||
| `postgresql.externalUrl` | External PostgreSQL URL | `""` |
|
||||
| `postgresql.auth.username` | PostgreSQL username | `formbricks` |
|
||||
| `postgresql.auth.password` | PostgreSQL password | `formbrickspassword` |
|
||||
| `postgresql.auth.database` | PostgreSQL database name | `formbricks` |
|
||||
| `postgresql.primary.persistence.enabled` | Enable persistence for PostgreSQL | `true` |
|
||||
| `postgresql.primary.persistence.size` | Size of persistent volume for PostgreSQL | `10Gi` |
|
||||
| Field | Description | Default |
|
||||
| ----------------------------------------------------------- | ------------------------------------------ | ------------------------------- |
|
||||
| `image.repository` | Docker image repository for Formbricks | `ghcr.io/formbricks/formbricks` |
|
||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||
| `image.tag` | Docker image tag | `"2.6.0"` |
|
||||
| `service.type` | Kubernetes service type | `ClusterIP` |
|
||||
| `service.port` | Kubernetes service port | `80` |
|
||||
| `service.targetPort` | Container port to expose | `3000` |
|
||||
| `resources.limits.cpu` | CPU resource limit | `500m` |
|
||||
| `resources.limits.memory` | Memory resource limit | `1Gi` |
|
||||
| `resources.requests.cpu` | Memory resource request | `null` |
|
||||
| `resources.requests.memory` | Memory resource request | `null` |
|
||||
| `autoscaling.enabled` | Enable autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum number of replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum number of replicas | `5` |
|
||||
| `autoscaling.metrics[0].type` | Type of metric for autoscaling | `Resource` |
|
||||
| `autoscaling.metrics[0].resource.name` | Resource name for autoscaling metric | `cpu` |
|
||||
| `autoscaling.metrics[0].resource.target.type` | Target type for autoscaling | `Utilization` |
|
||||
| `autoscaling.metrics[0].resource.target.averageUtilization` | Average utilization target for autoscaling | `80` |
|
||||
| `autoscaling.behavior.scaleDown.stabilizationWindowSeconds` | Stabilization window for scaling down | `300` |
|
||||
| `autoscaling.behavior.scaleUp.stabilizationWindowSeconds` | Stabilization window for scaling up | `0` |
|
||||
| `replicaCount` | Number of replicas | `1` |
|
||||
| `formbricksConfig.nextAuthSecret` | NextAuth secret | `""` |
|
||||
| `formbricksConfig.encryptionKey` | Encryption key | `""` |
|
||||
| `formbricksConfig.cronSecret` | Cron secret | `""` |
|
||||
| `env` | Additional environment variables | `{}` |
|
||||
| `hostname` | Hostname for Formbricks | `""` |
|
||||
| `traefik.enabled` | Enable Traefik ingress | `false` |
|
||||
| `traefik.ingressRoute.dashboard.enabled` | Enable Traefik dashboard | `false` |
|
||||
| `traefik.additionalArguments` | Additional arguments for Traefik | [See values.yaml] |
|
||||
| `traefik.tls.enabled` | Enable TLS for Traefik | `true` |
|
||||
| `traefik.tls.certResolver` | Cert resolver for Traefik | `letsencrypt` |
|
||||
| `traefik.ports.web.port` | HTTP port for Traefik | `80` |
|
||||
| `traefik.ports.websecure.port` | HTTPS port for Traefik | `443` |
|
||||
| `traefik.persistence.enabled` | Enable persistence for Traefik | `true` |
|
||||
| `traefik.persistence.size` | Size of persistent volume for Traefik | `128Mi` |
|
||||
| `traefik.podSecurityContext.fsGroup` | fsGroup for Traefik pods | `0` |
|
||||
| `traefik.hostNetwork` | Use host network for Traefik | `true` |
|
||||
| `traefik.securityContext` | Security context for Traefik | [See values.yaml] |
|
||||
| `redis.enabled` | Enable Redis | `true` |
|
||||
| `redis.externalUrl` | External Redis URL | `""` |
|
||||
| `redis.architecture` | Redis architecture | `standalone` |
|
||||
| `redis.auth.enabled` | Enable Redis authentication | `true` |
|
||||
| `redis.auth.password` | Redis password | `redispassword` |
|
||||
| `redis.master.persistence.enabled` | Enable persistence for Redis master | `false` |
|
||||
| `redis.replica.replicaCount` | Number of Redis replicas | `0` |
|
||||
| `postgresql.enabled` | Enable PostgreSQL | `true` |
|
||||
| `postgresql.externalUrl` | External PostgreSQL URL | `""` |
|
||||
| `postgresql.auth.username` | PostgreSQL username | `formbricks` |
|
||||
| `postgresql.auth.password` | PostgreSQL password | `formbrickspassword` |
|
||||
| `postgresql.auth.database` | PostgreSQL database name | `formbricks` |
|
||||
| `postgresql.primary.persistence.enabled` | Enable persistence for PostgreSQL | `true` |
|
||||
| `postgresql.primary.persistence.size` | Size of persistent volume for PostgreSQL | `10Gi` |
|
||||
|
||||
This table provides a comprehensive overview of all configurable fields in the Formbricks Helm chart, along with their descriptions and default values. Users can refer to this table to understand what each field does and how they can customize their Formbricks deployment.
|
||||
|
||||
@@ -619,13 +624,12 @@ Here are a few options:
|
||||
|
||||
Please check out [our contribution guide](https://formbricks.com/docs/developer-docs/contributing/get-started) and our [list of open issues](https://github.com/formbricks/formbricks/issues) for more information.
|
||||
|
||||
|
||||
|
||||
## MicroK8s Installation and Formbricks Deployment
|
||||
|
||||
### MicroK8s Quick Setup
|
||||
|
||||
1. Install MicroK8s:
|
||||
|
||||
```bash
|
||||
sudo snap install microk8s --classic
|
||||
```
|
||||
@@ -638,6 +642,7 @@ Please check out [our contribution guide](https://formbricks.com/docs/developer-
|
||||
### Deploying Formbricks on MicroK8s
|
||||
|
||||
1. Add the Formbricks Helm repository:
|
||||
|
||||
```bash
|
||||
microk8s helm3 repo add formbricks https://charts.formbricks.com
|
||||
microk8s helm3 repo update
|
||||
@@ -650,4 +655,4 @@ Please check out [our contribution guide](https://formbricks.com/docs/developer-
|
||||
|
||||
For more detailed information on MicroK8s, including advanced configuration and usage, please refer to the [official MicroK8s documentation](https://microk8s.io/docs).
|
||||
|
||||
For Formbricks Helm chart configuration options, see the [Configuration](#configuration) and [Full Values Documentation](#full-values-documentation) sections of this document.
|
||||
For Formbricks Helm chart configuration options, see the [Configuration](#configuration) and [Full Values Documentation](#full-values-documentation) sections of this document.
|
||||
|
||||
@@ -142,4 +142,4 @@ The API client is now ready to be used across your project. It can be used to in
|
||||
);
|
||||
```
|
||||
|
||||
If you have any questions or need help, feel free to reach out to us on our [Discord](https://formbricks.com/discord)
|
||||
If you have any questions or need help, feel free to reach out to us on [Github Discussions](https://github.com/formbricks/formbricks/discussions)
|
||||
|
||||
@@ -221,7 +221,6 @@
|
||||
"integrations": "Integrationen",
|
||||
"invite": "Einladen",
|
||||
"invite_them": "Lade sie ein",
|
||||
"join_discord": "Discord beitreten",
|
||||
"key": "Schlüssel",
|
||||
"label": "Bezeichnung",
|
||||
"language": "Sprache",
|
||||
@@ -781,14 +780,11 @@
|
||||
"identifying_your_users": "deine Nutzer identifizieren",
|
||||
"if_you_are_planning_to": "Wenn Du planst zu",
|
||||
"insert_this_code_into_the": "Füge diesen Code in die",
|
||||
"join_discord": "Discord beitreten",
|
||||
"join_discord_or_open_an_issue_on_github": "Trete Discord bei oder eröffne eine Issue auf GitHub",
|
||||
"need_a_more_detailed_setup_guide_for": "Brauche eine detailliertere Anleitung für",
|
||||
"not_working": "Klappt nicht?",
|
||||
"open_an_issue_on_github": "Eine Issue auf GitHub öffnen",
|
||||
"open_the_browser_console_to_see_the_logs": "Öffne die Browser Konsole, um die Logs zu sehen.",
|
||||
"open_the_browser_console_to_see_the_logs_2": "Öffne die Browser Konsole, um die Logs zu sehen.",
|
||||
"or": "oder",
|
||||
"receiving_data": "Daten werden empfangen 💃🕺",
|
||||
"scroll_to_the_top": "Scroll nach oben!",
|
||||
"step_1": "Schritt 1: Installiere mit pnpm, npm oder yarn",
|
||||
|
||||
@@ -221,7 +221,6 @@
|
||||
"integrations": "Integrations",
|
||||
"invite": "Invite",
|
||||
"invite_them": "Invite them",
|
||||
"join_discord": "Join Discord",
|
||||
"key": "Key",
|
||||
"label": "Label",
|
||||
"language": "Language",
|
||||
@@ -781,14 +780,11 @@
|
||||
"identifying_your_users": "identifying your users",
|
||||
"if_you_are_planning_to": "If you are planning to",
|
||||
"insert_this_code_into_the": "Insert this code into the",
|
||||
"join_discord": "Join Discord",
|
||||
"join_discord_or_open_an_issue_on_github": "Join Discord or open an issue on GitHub",
|
||||
"need_a_more_detailed_setup_guide_for": "Need a more detailed setup guide for",
|
||||
"not_working": "Not working?",
|
||||
"open_an_issue_on_github": "Open an issue on GitHub",
|
||||
"open_the_browser_console_to_see_the_logs": "Open the browser console to see the logs.",
|
||||
"open_the_browser_console_to_see_the_logs_2": "Open the browser console to see the logs.",
|
||||
"or": "or",
|
||||
"receiving_data": "Receiving data 💃🕺",
|
||||
"scroll_to_the_top": "Scroll to the top!",
|
||||
"step_1": "Step 1: Install with pnpm, npm or yarn",
|
||||
|
||||
@@ -221,7 +221,6 @@
|
||||
"integrations": "Integrações",
|
||||
"invite": "convidar",
|
||||
"invite_them": "Convida eles",
|
||||
"join_discord": "Entrar no Discord",
|
||||
"key": "Chave",
|
||||
"label": "Etiqueta",
|
||||
"language": "Língua",
|
||||
@@ -781,14 +780,11 @@
|
||||
"identifying_your_users": "identificando seus usuários",
|
||||
"if_you_are_planning_to": "Se você está planejando",
|
||||
"insert_this_code_into_the": "Insere esse código no",
|
||||
"join_discord": "Entrar no Discord",
|
||||
"join_discord_or_open_an_issue_on_github": "Entre no Discord ou abra uma issue no GitHub",
|
||||
"need_a_more_detailed_setup_guide_for": "Preciso de um guia de configuração mais detalhado para",
|
||||
"not_working": "Não tá funcionando?",
|
||||
"open_an_issue_on_github": "Abre uma issue no GitHub",
|
||||
"open_the_browser_console_to_see_the_logs": "Abre o console do navegador pra ver os logs.",
|
||||
"open_the_browser_console_to_see_the_logs_2": "Abre o console do navegador pra ver os logs.",
|
||||
"or": "ou",
|
||||
"receiving_data": "Recebendo dados 💃🕺",
|
||||
"scroll_to_the_top": "Rola pra cima!",
|
||||
"step_1": "Passo 1: Instale com pnpm, npm ou yarn",
|
||||
|
||||
12
pnpm-lock.yaml
generated
12
pnpm-lock.yaml
generated
@@ -604,9 +604,6 @@ importers:
|
||||
react-hot-toast:
|
||||
specifier: 2.4.1
|
||||
version: 2.4.1(csstype@3.1.3)(react-dom@19.0.0-rc-ed15d500-20241110(react@19.0.0-rc-ed15d500-20241110))(react@19.0.0-rc-ed15d500-20241110)
|
||||
react-icons:
|
||||
specifier: 5.3.0
|
||||
version: 5.3.0(react@19.0.0-rc-ed15d500-20241110)
|
||||
react-radio-group:
|
||||
specifier: 3.0.3
|
||||
version: 3.0.3(react-dom@19.0.0-rc-ed15d500-20241110(react@19.0.0-rc-ed15d500-20241110))(react@19.0.0-rc-ed15d500-20241110)
|
||||
@@ -11303,11 +11300,6 @@ packages:
|
||||
react: '>=16'
|
||||
react-dom: '>=16'
|
||||
|
||||
react-icons@5.3.0:
|
||||
resolution: {integrity: sha512-DnUk8aFbTyQPSkCfF8dbX6kQjXA9DktMeJqfjrg6cK9vwQVMxmcA3BfP4QoiztVmEHtwlTgLFsPuH2NskKT6eg==}
|
||||
peerDependencies:
|
||||
react: '*'
|
||||
|
||||
react-is@16.13.1:
|
||||
resolution: {integrity: sha512-24e6ynE2H+OKt4kqsOvNd8kBpV65zoxbA4BVsEOB3ARVWQki/DHzaUoC5KuON/BiccDaCCTZBuOcfZs70kR8bQ==}
|
||||
|
||||
@@ -26466,10 +26458,6 @@ snapshots:
|
||||
transitivePeerDependencies:
|
||||
- csstype
|
||||
|
||||
react-icons@5.3.0(react@19.0.0-rc-ed15d500-20241110):
|
||||
dependencies:
|
||||
react: 19.0.0-rc-ed15d500-20241110
|
||||
|
||||
react-is@16.13.1: {}
|
||||
|
||||
react-is@17.0.2: {}
|
||||
|
||||
Reference in New Issue
Block a user