Migrate data to external Postgres and storage

[danciaclara]

Description

Type of Change

• Bug fix (non-breaking change which fixes an issue)
• Feature (non-breaking change which adds functionality)
• Improvement (change that would cause existing functionality to not work as expected)
• Code refactoring
• Performance improvements
• Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

• Documentation
  • Added a new self-hosting migration guide for moving Plane from local PostgreSQL + MinIO to externally managed PostgreSQL and an S3-compatible object store.
  • Updated the self-hosting navigation to include “Migrate to external services” under Manage.
  • The guide covers a maintenance-window workflow, database export/restore steps, object storage bucket mirroring, environment variable updates, service restart, and backup retention guidance.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
developer-docs	Ready	Preview, Comment	Jul 10, 2026 10:08am

[coderabbitai]

Warning

Review limit reached

@danciaclara, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 58 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 303b73c0-6e52-405d-a517-91a70d0f57e5

📥 Commits

Reviewing files that changed from the base of the PR and between ee04b58 and fefaf4d.

📒 Files selected for processing (1)

• docs/self-hosting/manage/migration/migrate-data-to-external-services.md

📝 Walkthrough

Walkthrough

This PR adds a migration guide for moving Plane from local PostgreSQL and MinIO containers to managed PostgreSQL and S3-compatible storage, plus a matching VitePress sidebar link.

Changes

Migration Guide Documentation

Layer / File(s)	Summary
Guide navigation and database export docs/.vitepress/config.mts, docs/self-hosting/manage/migration/migrate-data-to-external-services.md	Adds the sidebar link and documents prerequisites, maintenance-window preparation, local service startup, database export, and dump verification.
Postgres restore and storage sync docs/self-hosting/manage/migration/migrate-data-to-external-services.md	Documents restoring into cloud PostgreSQL, handling client-version warnings, configuring MinIO and cloud storage aliases, and mirroring the uploads bucket.
Environment updates and finish docs/self-hosting/manage/migration/migrate-data-to-external-services.md	Lists database and S3 environment settings, then covers service restart, browser validation, and retaining the backup file.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• makeplane/developer-docs#272: Adds a related self-hosting page and sidebar navigation entry.

Suggested reviewers: pratapalakshmi

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: migrating data to external Postgres and storage services.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch migrate-data-to-external-services

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 4

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/self-hosting/manage/migration/migrate-data-to-external-services.md`:
- Around line 73-79: The MinIO migration steps mix credential names by
referencing AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY in the prose but still
using MINIO_ROOT_USER and MINIO_ROOT_PASSWORD in the mc alias set example.
Update the migration guide so the command uses the same local MinIO credential
names described above, and make sure the placeholders in the shell example match
the variables readers should pull from plane.env.
- Around line 1-4: The page frontmatter is missing the required keywords field,
so update the markdown frontmatter to include it alongside title and
description. Use the existing frontmatter block at the top of
migrate-data-to-external-services.md and add a keywords entry that matches the
document topic so it satisfies the docs rule for docs/**/*.md pages.
- Around line 25-35: The migration steps currently contradict each other because
docker compose down already stops plane-db and plane-minio, so the note after
that command should be reworded for consistency. Update the wording in the
migration guide around the docker compose down and docker compose up -d plane-db
plane-minio sequence to clearly say whether the intent is to keep the
volumes/data intact or to bring the services back up specifically for export,
and make the instructions in that section align with the actual behavior of
docker compose down.
- Around line 110-116: The environment variable example uses invalid env-file
syntax for AWS_REGION, so update the migration docs to use standard key=value
formatting consistently. In the example block under the external services setup,
change the AWS_REGION entry to match the other variables and ensure the snippet
remains valid for .env and Compose env files.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 30802ed8-b54c-4c9d-8b72-29501bfd20a1

📥 Commits

Reviewing files that changed from the base of the PR and between d0a531b and 9957997.

📒 Files selected for processing (2)

• docs/.vitepress/config.mts
• docs/self-hosting/manage/migration/migrate-data-to-external-services.md