Formbricks is a solution for in-product micro-surveys that promises to supercharge your product experience. Formbricks provides a free and open source surveying platform. Gather feedback at every point in the user journey with beautiful in-app, website, link and email surveys. In this step by step guide I will show you how to install Formbricks on your Synology NAS using Docker & Portainer.
Formbricks v2.7.0 release.
This guide works perfectly with the latestSTEP 1
Please Support My work by Making a Donation.
STEP 2
Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.
STEP 3
Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.
STEP 4
Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.
STEP 5
Now click the “Create” button. Follow the instructions in the image below.
STEP 6
After you click the Create button, the window below will open. Follow the instructions in the image below.
On the General area, set the Reverse Proxy Name description: type in Formbricks. After that, add the following instructions:
Source:
Protocol: HTTPS
Hostname: formbricks.yourname.synology.me
Port: 443
Check Enable HSTS
Destination:
Protocol: HTTP
Hostname: localhost
Port: 3774
STEP 7
On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.
STEP 8
Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.
STEP 9
Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.
STEP 10
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it formbricks. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 11
Now create two new folders inside the formbricks folder that you created at STEP 10 and name them db and uploads. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 12
Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.
STEP 13
Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.
STEP 14
In the Name field type in formbricks. Follow the instructions in the image below.
services: db: image: pgvector/pgvector:pg15 container_name: Formbricks-DB hostname: formbricks-db mem_limit: 1g cpu_shares: 1024 security_opt: - no-new-privileges:true healthcheck: test: ["CMD", "pg_isready", "-q", "-d", "formbricks", "-U", "formbricksuser"] timeout: 45s interval: 10s retries: 10 volumes: - /volume1/docker/formbricks/db:/var/lib/postgresql/data:rw environment: POSTGRES_DB: formbricks POSTGRES_USER: formbricksuser POSTGRES_PASSWORD: formbrickspass restart: on-failure:5 formbricks: image: ghcr.io/formbricks/formbricks:latest restart: on-failure:5 container_name: Formbricks healthcheck: test: curl -f http://localhost:3000/ || exit 1 depends_on: - db ports: - 3774:3000 volumes: - /volume1/docker/formbricks/uploads:/home/nextjs/apps/web/uploads/:rw environment: WEBAPP_URL: https://formbricks.yourname.synology.me DATABASE_URL: "postgresql://formbricksuser:formbrickspass@formbricks-db:5432/formbricks?schema=public" NEXTAUTH_SECRET: v6M37byB5LwYHCPZyCJzDGNUSsHY4grj NEXTAUTH_URL: https://formbricks.yourname.synology.me ENCRYPTION_KEY: v6M37byB5LwYHCPZyCJzDGNUSsHY4grj CRON_SECRET: MariushostingMariushostingMari13 POSTGRES_PASSWORD: formbrickspass # ENTERPRISE_LICENSE_KEY: EMAIL_VERIFICATION_DISABLED: 1 #Set to 0 to enable Email verification for new signups. PASSWORD_RESET_DISABLED: 0 #Set to 1 to enable Password Reset. SIGNUP_DISABLED: 0 #Set to 1 to disbale Signups. INVITE_DISABLED: 0 #Set to 1 to disable Invites MAIL_FROM: Your-own-gmail-address SMTP_HOST: smtp.gmail.com SMTP_PORT: 587 SMTP_SECURE_ENABLED: 1 SMTP_USER: Your-own-gmail-address SMTP_PASSWORD: Your-own-app-password # SHORT_URL_BASE: # EMAIL_AUTH_DISABLED: # PRIVACY_URL: # TERMS_URL: # IMPRINT_URL: # GITHUB_ID: # GITHUB_SECRET: # GOOGLE_CLIENT_ID: # GOOGLE_CLIENT_SECRET: # DEFAULT_TEAM_ID: # DEFAULT_TEAM_ROLE: admin # ONBOARDING_DISABLED: 1
Note: Before you paste the code above in the Web editor area below, change the value for WEBAPP_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for NEXTAUTH_URL and type in your own synology.me DDNS with https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for CRON_SECRET and add your own CRON_SECRET. MariushostingMariushostingMari13 is an example for a CRON SECRET. You should invent your own Value. Add 32 random characters, both letters and numbers.
Note: Before you paste the code above in the Web editor area below, change the value for MAIL_FROM and type in your own Gmail address. STEP 12.
Note: Before you paste the code above in the Web editor area below, change the value for SMTP_USER and type in your own Gmail address. STEP 12.
Note: Before you paste the code above in the Web editor area below, change the value for SMTP_PASSWORD and type in your own Gmail app password. STEP 12.
STEP 15
Scroll down on the page until you see a button called Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.
STEP 16
If everything goes right, you will see this message at the top right of your screen: “Success Stack successfully deployed“.
STEP 17
Go back to STEP 1 or you will deal with karma 🙂.
STEP 18
Now open your browser and type in your HTTPS/SSL certificate like this https://formbricks.yourname.synology.me In my case it’s https://formbricks.mariushosting.synology.me If everything goes right, you will see the Formbricks Login Page. Click Get started. Follow the instructions in the image below.
STEP 19
Click Continue with Email to Create your Administrator user. Follow the instructions in the image below.
STEP 20
Type in your own details, then click Continue with Email. Follow the instructions in the image below.
STEP 21
Click Login. Follow the instructions in the image below.
STEP 22
Click Login with Email. Follow the instructions in the image below.
STEP 23
Type in your own Email and Password that you have previously created at STEP 20, then click Login with Email. Follow the instructions in the image below.
STEP 24
Type in a name for your organization, then click Continue. Follow the instructions in the image below.
STEP 25
Invite a new member to your Organization via email, then click Continue. Follow the instructions in the image below.
STEP 26
Select where do you want to survey people. After your selection, go straight to the next STEP.
STEP 27
Select which industry do you work for. After your selection, go straight to the next STEP.
STEP 28
Give a name to your product, then select your favorite background color. Click Next. Follow the instructions in the image below.
STEP 29
Copy code to add it on your website, then click “I don’t know how to do it“. Follow the instructions in the image below.
STEP 30
Click Not now. Follow the instructions in the image below.
STEP 31
Your Formbricks dashboard at a glance!
Enjoy Formbricks!
Note: Check the full Formbricks documentation!
If you encounter issues by using this container, make sure to check out the Common Docker issues article.
Fix: If your Gmail notifications don’t work, change the smtp port at STEP 14 from SMTP_PORT: 587 to SMTP_PORT: 465 then update the stack.
Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Formbricks container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.
This post was updated on Sunday / November 10th, 2024 at 4:13 PM