Skip to content

Commit 6e99ca6

Browse files
authored
docs: move restore to new project docs to own page (supabase#37633)
1 parent 952698e commit 6e99ca6

File tree

5 files changed

+52
-40
lines changed

5 files changed

+52
-40
lines changed

apps/docs/components/Navigation/NavigationMenu/NavigationMenu.constants.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2181,6 +2181,10 @@ export const platform: NavMenuConstant = {
21812181
name: 'Transfer Project',
21822182
url: '/guides/platform/project-transfer',
21832183
},
2184+
{
2185+
name: 'Duplicate Project',
2186+
url: '/guides/platform/clone-project',
2187+
},
21842188
{
21852189
name: 'Single Sign-On',
21862190
url: '/guides/platform/sso',

apps/docs/content/guides/platform/backups.mdx

Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -171,44 +171,7 @@ For a detailed breakdown of how charges are calculated, refer to [Manage Point-i
171171

172172
## Restore to a new project
173173

174-
Supabase provides a convenient way to restore data from an existing project into a completely new one. Whether you're using physical backups or Point-in-Time recovery (PITR), this feature allows you to duplicate project data with ease, perform testing safely, or recover data for analysis. Access to this feature is exclusive to users on paid plans and requires that physical backups are enabled for the source project.
175-
176-
<Admonition type="note">
177-
178-
PITR is an additional add-on available for organizations on a paid plan with physical backups enabled.
179-
180-
</Admonition>
181-
182-
To begin, switch to the source project—the project containing the data you wish to restore—and go to the [database backups](https://supabase.com/dashboard/project/_/database/backups/restore-to-new-project) page. Select the **Restore to a New Project** tab.
183-
184-
A list of available backups is displayed. Select the backup you want to use and click the "Restore" button. For projects with PITR enabled, use the date and time selector to specify the exact point in time from which you wish to restore data.
185-
186-
Once you’ve made your choice, Supabase takes care of the rest. A new project is automatically created, replicating key configurations from the original, including the compute instance size, disk attributes, SSL enforcement settings, and network restrictions. The data will remain in the same region as the source project to ensure compliance with data residency requirements. The entire process is fully automated.
187-
188-
<Admonition type="note">
189-
190-
The time required to complete the restoration can vary depending largely on the volume of data involved. If you have a large amount of data you can opt for higher performing disk attributes on the source project _before_ starting a clone operation. These disk attributes will be replicated to the new project. This incurs additional costs which will be displayed before starting.
191-
192-
</Admonition>
193-
194-
There are a few important restrictions to be aware of with the "Restore to a New Project" process:
195-
196-
- Projects that are created through the restoration process cannot themselves be used as a source for further clones at this time.
197-
- The feature is only accessible to paid plan users with physical backups enabled, ensuring that the necessary resources and infrastructure are available for the restore process.
198-
199-
Before starting the restoration, you’ll be presented with an overview of the costs associated with creating the new project. The new project will incur additional monthly expenses based on the mirrored resources from the source project. It’s important to review these costs carefully before proceeding.
200-
201-
Once the restoration is complete, the new project will be available in your dashboard and will include all data, tables, schemas, and selected settings from the chosen backup source. It is recommended to thoroughly review the new project and perform any necessary tests to ensure everything has been restored as expected.
202-
203-
New projects are completely independent of their source, and as such can be modified and used as desired.
204-
205-
<Admonition type="note">
206-
207-
As the entire database is copied to the new project, this will include all extensions that were enabled at the source. If the source project included extensions that are configured to carry out external operations—for example pg_net, pg_cron, wrappers—these should be disabled once the copy process has completed to avoid any unwanted actions from taking place.
208-
209-
</Admonition>
210-
211-
Restoring to a new project is an excellent way to manage environments more effectively. You can use this feature to create staging environments for testing, experiment with changes without risk to production data, or swiftly recover from unexpected data loss scenarios.
174+
See the [Duplicate Project docs](/docs/guides/platform/clone-project).
212175

213176
## Troubleshooting
214177

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
title: Duplicate project
3+
subtitle: How to clone your existing Supabase project
4+
---
5+
6+
You can clone your Supabase project by restoring your data from an existing project into a completely new one. Note that this only duplicates your database, not your project configuration.
7+
8+
Whether you're using physical backups or Point-in-Time recovery (PITR), this feature allows you to duplicate project data with ease, perform testing safely, or recover data for analysis. Access to this feature is exclusive to users on paid plans and requires that physical backups are enabled for the source project.
9+
10+
<Admonition type="note">
11+
12+
PITR is an additional add-on available for organizations on a paid plan with physical backups enabled.
13+
14+
</Admonition>
15+
16+
To begin, switch to the source project—the project containing the data you wish to restore—and go to the [database backups](https://supabase.com/dashboard/project/_/database/backups/restore-to-new-project) page. Select the **Restore to a New Project** tab.
17+
18+
A list of available backups is displayed. Select the backup you want to use and click the "Restore" button. For projects with PITR enabled, use the date and time selector to specify the exact point in time from which you wish to restore data.
19+
20+
Once you’ve made your choice, Supabase takes care of the rest. A new project is automatically created, replicating key configurations from the original, including the compute instance size, disk attributes, SSL enforcement settings, and network restrictions. The data will remain in the same region as the source project to ensure compliance with data residency requirements. The entire process is fully automated.
21+
22+
<Admonition type="note">
23+
24+
The time required to complete the restoration can vary depending largely on the volume of data involved. If you have a large amount of data you can opt for higher performing disk attributes on the source project _before_ starting a clone operation. These disk attributes will be replicated to the new project. This incurs additional costs which will be displayed before starting.
25+
26+
</Admonition>
27+
28+
There are a few important restrictions to be aware of with the "Restore to a New Project" process:
29+
30+
- Projects that are created through the restoration process cannot themselves be used as a source for further clones at this time.
31+
- The feature is only accessible to paid plan users with physical backups enabled, ensuring that the necessary resources and infrastructure are available for the restore process.
32+
33+
Before starting the restoration, you’ll be presented with an overview of the costs associated with creating the new project. The new project will incur additional monthly expenses based on the mirrored resources from the source project. It’s important to review these costs carefully before proceeding.
34+
35+
Once the restoration is complete, the new project will be available in your dashboard and will include all data, tables, schemas, and selected settings from the chosen backup source. It is recommended to thoroughly review the new project and perform any necessary tests to ensure everything has been restored as expected.
36+
37+
New projects are completely independent of their source, and as such can be modified and used as desired.
38+
39+
<Admonition type="note">
40+
41+
As the entire database is copied to the new project, this will include all extensions that were enabled at the source. If the source project included extensions that are configured to carry out external operations—for example pg_net, pg_cron, wrappers—these should be disabled once the copy process has completed to avoid any unwanted actions from taking place.
42+
43+
</Admonition>
44+
45+
Restoring to a new project is an excellent way to manage environments more effectively. You can use this feature to create staging environments for testing, experiment with changes without risk to production data, or swiftly recover from unexpected data loss scenarios.

apps/docs/content/guides/platform/migrating-within-supabase.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ subtitle: Learn how to migrate from one Supabase project to another
44
---
55

66
If you are on a Paid Plan and have physical backups enabled, you should instead use the [Restore
7-
to another project feature](/docs/guides/platform/backups#restore-to-a-new-project)
7+
to another project feature](/docs/guides/platform/clone-project).
88

99
## Database migration guides
1010

apps/www/_blog/2024-12-06-restore-to-a-new-project.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ toc_depth: 3
1515
launchweek: '13'
1616
---
1717

18-
Today we’re adding [Restore to a New Project](https://supabase.com/docs/guides/platform/backups#restore-to-a-new-project).
18+
Today we’re adding [Restore to a New Project](https://supabase.com/docs/guides/platform/clone-project).
1919

2020
You can use this new tool to copy data easily from an existing Supabase project to a new one. **Restore to a New Project** integrates seamlessly with daily physical backups and Point-in-Time Recovery (PITR) to provide flexible restoration options.
2121

0 commit comments

Comments
 (0)