Skip to content

Commit c59e9e4

Browse files
committed
Update v3 docs
1 parent 4b27969 commit c59e9e4

File tree

1 file changed

+54
-10
lines changed

1 file changed

+54
-10
lines changed

docs/install_setup/v3.md

Lines changed: 54 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
# Gramps 6.0 upgrade guide
22

3-
Gramps 6.0 was released on March 19, 2025.
3+
Gramps 6.0 was released on March 19, 2025. Since it uses a new family tree database schema compared to Gramps 5.2, additional steps are necessary when upgrading Gramps Web to be used with Gramps 6.0. This page describes the necessary steps.
44

5-
Gramps Web is **not yet compatible** with Gramps 6.0. If you are using Gramps Web and intend to [synchronize](../administration/sync.md) it with Gramps Desktop, please **do not upgrade to Gramps 6.0** until a new version of Gramps Web is released that is compatible with Gramps 6.0.
5+
!!! info
6+
Last updated: May 5, 2025
67

7-
This page will be updated accordingly.
88

9-
A **beta version** of Gramps Web for Gramps 6.0 is now available for testing! See [this thread](https://gramps.discourse.group/t/gramps-web-gramps-6-0-beta-testers-wanted/7523) for more information.
9+
## Overview of the steps
1010

1111

12-
!!! info
13-
Last updated: April 24, 2025
12+
This is an overview of the steps required to upgrade.
13+
It also shows which steps are executed by the administrator of the Gramps Web server, the owner of the family tree, and whether it's needed only for users of the [sync addon](../administration/sync.md)
14+
15+
Server administrator | Tree owner | Action
16+
----|----|----
17+
  | ✓ | Back up your family tree
18+
&nbsp; | ✓ <sup>1</sup> | [Synchronize Gramps Web with Gramps Desktop](../administration/sync.md)
19+
✓ | | [Update Gramps Web](update.md)
20+
&nbsp; | ✓ | Update the tree's database schema
21+
&nbsp; | ✓ <sup>1</sup> | Update Gramps Desktop
22+
&nbsp; | ✓ <sup>1</sup> | Install the updated Sync Addon
23+
&nbsp; | ✓ | Back up your family tree
24+
&nbsp; | ✓ <sup>1</sup> | [Synchronize Gramps Web with Gramps Desktop](../administration/sync.md)
25+
26+
27+
<sup>1</sup> Only needed if you synchronize Gramps Web with Gramps Desktop.
1428

1529

1630
## Overview of the release status
@@ -20,8 +34,38 @@ The following table gives an overview of when the components needed for Gramps W
2034
Component | Released
2135
---|---
2236
Gramps 6.0.1 | 2025-04-18
23-
Gramps Web API 3.0.0 | &ndash;
24-
Gramps Web (Frontend) 25.5.? | &ndash;
25-
Gramps Web Sync Addon for Gramps 6.0 | &ndash;
26-
PostgreSQL Addon for Gramps 6.0 | &ndash;
37+
Gramps Web API 3.0.0 | 2025-05-04
38+
Gramps Web (Frontend) 25.5.0 | &ndash;
39+
Gramps Web Sync Addon 1.3.2 | 2025-04-30
2740
SharedPostgreSQL Addon 0.1.12 | 2025-03-20
41+
42+
43+
## Detailed steps
44+
45+
This section provides more details about some of the individual steps above.
46+
47+
### Back up your family tree
48+
49+
In Gramps Web, go to the "Export" page and select "Gramps XML (family tree)" (the default option). Click "Generate" and wait until the download of the .gramps file starts.
50+
51+
You can also create a backup in Gramps Desktop [in the usual way](https://www.gramps-project.org/wiki/index.php/How_to_make_a_backup).
52+
53+
### Update the tree's database schema
54+
55+
When you access Gramps Web for the first time after having upgraded it, you will be presented with a screen showing the message:
56+
57+
> The Family Tree you are trying to load is in a schema version not supported by this version of Gramps Web. Therefore you cannot load this Family Tree without upgrading its schema. This action cannot be undone.
58+
59+
You can now click on the button "Upgrade Family Tree". It will show a progress bar and should not take more than a minute to complete. Don't worry, if you accidentally close your browser window, the conversion will continue in the background.
60+
61+
!!! warning
62+
If you use a non-standard setup *without* background task queue, the database upgrade might fail and your family tree might get corrupted. You can check (before updating Gramps Web) if you are using a background task queue by going to the "System Information" section in the settings and making sure it has "task queue: true".
63+
64+
65+
### Update Gramps Desktop
66+
67+
Follow the Gramps Desktop installation instructions for your operating system.
68+
69+
### Install the updated Sync Addon
70+
71+
You can use the Plugin Manager in Gramps 6.0 to install the Gramps Web Sync addon. Search for Gramps Web Sync, click on install, and restart Gramps.

0 commit comments

Comments
 (0)