Service: Formbricks - EyevinnOSC/community GitHub Wiki

Formbricks

Formbricks (serviceId formbricks-formbricks) is an open source Qualtrics alternative for creating privacy-first, conversion-optimized surveys. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 20 GiB of storage per instance. Source: formbricks/formbricks.

What it can do

  • Create and run surveys and collect user feedback.
  • Store survey data in a PostgreSQL database that you provide.
  • Support file uploads in surveys when an S3 bucket is configured.

Creating an instance

Create a PostgreSQL database first and confirm it is running. The Postgres Vector service (pgvector-pgvector) works:

  1. Store the database password as a service secret (create-service-secret, serviceId: "pgvector-pgvector", name dbpassword).
  2. create-service-instance with serviceId: "pgvector-pgvector" and { "name": "formbricks", "PostgresPassword": "{{secrets.dbpassword}}", "PostgresUser": "formbricks", "PostgresDb": "formbricks" }.
  3. When it is running, read the address and port with describe-service-instance and build the URL postgresql://formbricks:<db-password>@<instance-ip>:<instance-port>/formbricks.

Store that whole URL as a service secret for Formbricks (create-service-secret, serviceId: "formbricks-formbricks", name psql); a {{secrets.NAME}} reference only works as the entire field value. Then create the instance with serviceId: "formbricks-formbricks":

{
  "name": "guide",
  "DatabaseUrl": "{{secrets.psql}}"
}

Verify with wait-for-service-ready or describe-service-instance, then open the instance URL in a browser.

Options

Option Required Type Meaning
name Yes string Name of the instance. Alphanumeric/word characters only (^\w+$), at most 20 characters.
DatabaseUrl Yes string, sensitive PostgreSQL connection URL, for example postgresql://user:password@host:5432/formbricks. Sets DATABASE_URL. The OSC entrypoint exits if it is not set.
AwsAccessKeyId No string, sensitive Access key ID for the S3 account used for file uploads.
AwsSecretAccessKey No string, sensitive Secret access key that belongs to AwsAccessKeyId.
AwsRegion No string AWS region of the upload bucket.
S3BucketName No string Name of the S3 bucket for uploaded files (upstream S3_BUCKET_NAME), for example my-formbricks-uploads. Formbricks enables file upload features only when this is set.
S3EndpointUrl No string Endpoint URL of an S3-compatible provider such as MinIO, DigitalOcean Spaces or Wasabi (upstream S3_ENDPOINT_URL), for example https://nyc3.digitaloceanspaces.com. Leave empty for AWS S3.

Pass sensitive options (DatabaseUrl, AwsAccessKeyId, AwsSecretAccessKey) as {{secrets.NAME}} secrets.

Limitations

  • Storage is limited to 20 GiB per instance.
  • File uploads need S3 settings (S3BucketName and credentials); without a bucket the upload features are disabled.

Resources