mirror/formbricks
1
0
Fork 0
mirror of https://github.com/formbricks/formbricks.git synced 2026-05-05 11:21:07 -05:00
Code Issues Packages Projects Releases 169 Wiki Activity

feat: add redis migration script (#6575)

Browse Source 
Co-authored-by: Matti Nannt <matti@formbricks.com>
Co-authored-by: pandeymangg <anshuman.pandey9999@gmail.com>
This commit is contained in:
Victor Hugo dos Santos
2025-09-22 08:18:02 -03:00
committed by GitHub
parent 5d53ed76ed
commit 1557ffcca1
4 changed files with 469 additions and 182 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/self-hosting/setup/minio-migration.mdx
-106
View File
@@ -1,106 +0,0 @@
---
title: Migrate local uploads to MinIO
description: One‑click migration from local file storage to the new MinIO storage required in 4.0
icon: "cloud"
---
## Why this migration is required
Formbricks 4.0 uses an S3‑compatible object store for all file uploads. For One‑Click installs that previously stored files locally (named volume `uploads` or a host bind like `./uploads`), you must migrate those files to MinIO.
This guide shows a safe, idempotent migration using the script `docker/migrate-to-minio.sh` included in this repository.
<Note>
This migration script is supported on Ubuntu only (Ubuntu 20.04+), requiring Bash 4+ and GNU sed/grep.
</Note>
## Prerequisites
- DNS: a subdomain for object storage, e.g. `files.<your-domain>` pointing to your server IP
- Your One‑Click installation directory (contains `docker-compose.yml`)
- Docker/Compose installed and working
## What the script does
- Adds MinIO services (`minio`, `minio-init`) and S3 env vars to `docker-compose.yml`
- Asks to restart your Compose stack (you should say Yes)
- Detects your existing upload sources post‑start and migrates them to MinIO
- Host bind mounts (e.g., `./uploads`)
- Named volume target in the container (legacy: `/home/nextjs/apps/web/uploads` or custom target)
- Absolute `UPLOADS_DIR` in the container if set
- Cleans up `docker-compose.yml` after success: removes `UPLOADS_DIR`, removes all `uploads` volume mappings and the root `uploads:` definition
- Optionally restarts again to apply the cleanup
The migration is idempotent: you can re‑run it; existing objects are not duplicated.
## Run the migration
From the directory that contains your `docker-compose.yml`:
```bash
# Download the latest script
curl -fsSL -o migrate-to-minio.sh \
https://raw.githubusercontent.com/formbricks/formbricks/stable/docker/migrate-to-minio.sh
# Make it executable
chmod +x migrate-to-minio.sh
# Launch the guided migration
./migrate-to-minio.sh
```
## Verifying the migration
- Check the UI: previously uploaded images/logos/files should load
- List bucket contents with `mc` (reuses minio‑init service env):
```bash
docker compose run --rm --entrypoint /bin/sh minio-init -lc \
'mc alias set minio http://minio:9000 "$MINIO_ROOT_USER" "$MINIO_ROOT_PASSWORD" && \
mc ls -r "minio/$MINIO_BUCKET_NAME" | head -200'
```
- Confirm `docker-compose.yml` no longer contains `UPLOADS_DIR` or `uploads:` volume mappings (post‑cleanup)
## Notes on sources
- The script migrates from multiple sources, in order:
- Host bind (absolute path resolved by `docker compose config`)
- Container mount target for named volume `uploads` (e.g., `/home/nextjs/apps/web/uploads` or your custom `.../files/uploads`)
- Absolute `UPLOADS_DIR` (container path)
- The relative path/key structure is preserved: `${environmentId}/${accessType}/fileName.ext`
- Re‑runs copy only new/changed files (idempotent)
## Troubleshooting
- MinIO 404 on file URLs
- If you use virtual‑hosted style (`bucket.files.domain`), ensure Traefik router rule includes wildcard:
```
traefik.http.routers.minio-s3.rule=Host(`files.domain`) || HostRegexp(`{any:.+}.files.domain`)
```
- InvalidAccessKeyId in UI
- Happens if keys rotated between runs. Re‑run the script; it reuses S3\_\* credentials and reattaches policy.
- Undefined volume `minio-data`
- Re‑run; the script ensures `minio-data` exists in the root `volumes:` block.
- List bucket contents
```bash
docker compose run --rm --entrypoint /bin/sh minio-init -lc \
'mc alias set minio http://minio:9000 "$MINIO_ROOT_USER" "$MINIO_ROOT_PASSWORD"; \
mc ls -r "minio/$MINIO_BUCKET_NAME" | head -200'
```
## Rollback
- Your original `docker-compose.yml` is backed up as `docker-compose.yml.backup.<timestamp>`
- To revert, restore the backup and restart Compose:
```bash
cp docker-compose.yml.backup.<timestamp> docker-compose.yml
docker compose down && docker compose up -d
```
That’s it — you’re on the new MinIO storage for Formbricks 4.0. ✅