Difference between revisions of "Installing Gramps for macOS computers"

From Gramps
m ({{new|5.2.0}})
(MacPorts: No hypen shown on "Third-party Addons" page stick to one spelling.)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{languages|Download}}
+
{{languages|Installing Gramps for macOS computers}}
{{man warn|1=🚧 Work In Progress {{new|5.2.0}}|2=This wikipage is a cloned outline from the Download page. It is being converted to a "Installing" style instead of a "Download".
 
{{#vardefine:chapter|HowDoI}} <!-- Used in labeling 'Figures' -->
 
Since you are reading '''''this paragraph''''', then the WikiContributor has not progressed to the point of trimming out the excess template material. That means the wikipage is probably not ready for collaborative editing yet. Multiple people editing ''now'' might unintentionally overwrite their work. Please post your (very welcome) suggestion on the '''Discussion''' page instead of directly editing the content. Conversion completion expected by 18 Feb 2024.}}
 
'''Research, organize and share your family tree with Gramps.'''
 
 
 
{{man note|{{Man menu|Gramps '''Current version: '''{{version}}''' Released: '''2023-06-29'''}}|For a list of updates see: ''[[Gramps 5.1 Wiki Manual - What's new?|What's new?]]}}  
 
  
 
{{man warn|Before upgrading your distribution|Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format<sup>1</sup>]].}}
 
{{man warn|Before upgrading your distribution|Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format<sup>1</sup>]].}}
 
+
[[File:macos_200x200.png|248px|right]]
 
 
[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]
 
Before downloading read the [[Mac OS X:Application package|before installation]] instructions.
 
<big>
 
* <u>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]</u>
 
* <u>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_arm}}.dmg Apple Silicon {{version_Mac}}]</u>
 
</big>
 
After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it.
 
{{-}}
 
<hr />
 
 
 
Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.
 
{{-}}
 
<br />
 
 
 
 
 
 
 
 
<span id="Mac OS X><!-- backward compatibility hyperlinking anchor-->
 
<span id="Mac OS X><!-- backward compatibility hyperlinking anchor-->
  
== macOS ==
+
== Application package ==
 
</span>
 
</span>
[[File:macos_200x200.png|128px|left|link=Download#Mac_OS_X]]  
+
The [[Mac_OS_X:Application_package|application package]] is the recommended way of installing Gramps on macOS.
  
Before downloading the ready-to-run stand-alone bundle: Use your '''earlier version of Gramps''' to [[How_to_make_a_backup#Gramps_version_3.3_and_later|backup]] your Family Trees to the hardy and portable [[#1|XML format<sup>1</sup>]]. Read the [[Mac OS X:Application package|before installation]] instructions.
+
First read the [[Mac OS X:Application package|before installation]] instructions.
  
 
Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 14 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_14:_%Sonoma%22 Sonoma]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''
 
Tested for compatibility with Apple macOS/Mac OS X versions 10.13 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_10.13:_%22High_Sierra%22 High Sierra]) through 14 ([https://en.wikipedia.org/wiki/MacOS_version_history#Version_14:_%Sonoma%22 Sonoma]). ''Help determining your Operating System version can be found in the [https://support.apple.com/en-us/HT201260 HT201260 Apple Support article.]''
 
<big>
 
* <u>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_intel}}.dmg Intel {{version_Mac}}]</u>
 
* <u>[{{github_url}}/releases/download/v{{version_Mac}}/{{Filename_mac_arm}}.dmg Apple Silicon {{version_Mac}}]</u>
 
</big>
 
  
 
After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)
 
After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)
  
 +
Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.
  
Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, '''Create''' a new Family Tree and [[How_to_restore_a_backup|'''Import''' the back-up]] into this new Tree.
+
{{-}}
  
=== Alternative independent installation ===
+
=== Adding additional Spell Checking languages on macOS ===
[[File:Gramps-release.png|left]]
+
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}
Alternatively, Gramps can also be built and installed on macOS using MacPorts.
 
  
 
{{-}}
 
{{-}}
==== MacPorts ====
+
 
 +
== MacPorts ==
  
 
MacPorts is a package manager for Apple Mac.
 
MacPorts is a package manager for Apple Mac.
Line 57: Line 30:
 
* [[Mac_OS_X:Build_from_source:MacPorts|MacPorts]]
 
* [[Mac_OS_X:Build_from_source:MacPorts|MacPorts]]
  
Why use the version from MacPorts?  Certain plugins or add-ons require additional supporting software in order to operate.  With MacPorts, you can install such software easily (most of the time; there could be exceptions).  With the official .dmg installer, installing such additional software is more difficult or impossible.
+
Why use the version from MacPorts?  Certain plugins or addons require additional supporting software in order to operate.  With MacPorts, you can install such software easily (most of the time; there could be exceptions).  With the official .dmg installer, installing such additional software is more difficult or impossible.
  
The [[Addon:Prerequisites_Checker_Gramplet|Prequisites Checker]] can identify if any add-ons have been installed that require such additional software.
+
The [[Addon:Prerequisites_Checker_Gramplet|Prequisites Checker]] can identify if any addons have been installed that require such additional software.
  
 
{{-}}
 
{{-}}
  
==== Homebrew ====
+
== Homebrew ==
 
 
The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is *not* a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.
 
  
 +
The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is '''not''' a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.
  
 
[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).  
 
[https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew] is an open-source package manager for macOS (and Linux).  
  
 
See https://github.com/homebrew/
 
See https://github.com/homebrew/
 
 
{{-}}
 
 
=== Adding additional Spell Checking languages on macOS ===
 
{{man tip|[[Mac_OS_X:Application_package#Dictionaries|Spell Checking:]]|Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from [https://extensions.openoffice.org/ OpenOffice.org's website]. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from <tt>oxt</tt> to <tt>zip</tt>, then from the context menu select '''Open with... Archive Utility''' to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, <tt>foo.aff</tt> and <tt>foo.dic</tt>. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like <tt>fr-moderne.aff</tt> and <tt>fr-moderne.dic</tt>. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to <tt>fr.aff</tt> and <tt>fr.dic</tt> or <tt>fr_FR.aff</tt> and <tt>fr_FR.dic</tt>. You can have more than one dictionary pair installed if you use several languages, but one '''must''' match the language you use for Gramps or spell checking won't be enabled at all.}}
 
  
 
{{-}}
 
{{-}}
Line 82: Line 48:
 
== Notes ==
 
== Notes ==
 
<span id="1">Backup to '''Gramps XML''' format when updating. ''Although Gramps reads and writes '''GEDCOM 5.5.1''' format fluently (because it is the de facto format for genealogical data interchange), never depend on such a rudimentary format for archiving your research. GEDCOM cannot store all the intricacies found in Gramps data.'' Always backup with the more robust Gramps XML format.</span>  
 
<span id="1">Backup to '''Gramps XML''' format when updating. ''Although Gramps reads and writes '''GEDCOM 5.5.1''' format fluently (because it is the de facto format for genealogical data interchange), never depend on such a rudimentary format for archiving your research. GEDCOM cannot store all the intricacies found in Gramps data.'' Always backup with the more robust Gramps XML format.</span>  
 +
 +
[[File:Menubar-FamilyTrees-overview-FamilyTree-Loaded-example-60.png|thumb|right|450px|Menubar - {{man menu|"Family Trees > Make Backup..."}}]]
  
 
You will find a [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Backing_up_a_Family_Tree|{{Man menu|Make Backup...}}]] option in the {{Man menu|Family Trees}} menu of recent Gramps versions. Alternately, use [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|{{Man menu|Export...}}]] in the same menu but deselect the privacy and filtering options in the Exporter Assistant to avoid omission of any data.  
 
You will find a [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Backing_up_a_Family_Tree|{{Man menu|Make Backup...}}]] option in the {{Man menu|Family Trees}} menu of recent Gramps versions. Alternately, use [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Exporting_data|{{Man menu|Export...}}]] in the same menu but deselect the privacy and filtering options in the Exporter Assistant to avoid omission of any data.  
Line 89: Line 57:
 
== See also ==
 
== See also ==
 
===Installing Gramps for Desktops===
 
===Installing Gramps for Desktops===
* on [[Installing Gramps for Linux computers|Linux distributions]]
+
Installation instructions specific to the different OSes are on the [[File:linux_32x32.png|link=Installing_Gramps_for_Linux_computers#Linux_distributions]], [[File:windows_32x32.png|link=Installing_Gramps_for_Windows_computers]],[[File:macos_200x200.png|32px|link=Installing_Gramps_for_macOS_computers]] and [[File:Bsd daemon.png|32px|link=BSD_platforms]] pages.
* on [[Installing Gramps for macOS computers|macOS]]
 
* on [[Installing Gramps for Windows computers|Windows]]
 
* on [[Installing_Gramps_for_Linux_computers#BSD|BSD]] (descended from the discontinued [https://en.wikipedia.org/wiki/Berkeley_Software_Distribution Berkeley Standard Distribution])
 
  
 
===GitHub Gramps for Desktops Releases===<!--github_url template = https://github.com/gramps-project/gramps -->
 
===GitHub Gramps for Desktops Releases===<!--github_url template = https://github.com/gramps-project/gramps -->
Line 102: Line 67:
  
 
===Installing Gramps Web for online collaboration===
 
===Installing Gramps Web for online collaboration===
* Docker
+
[https://gramps-project.org/blog/web/ Gramps Web] is a frontend for a hosted instance of Gramps
 +
* [https://www.grampsweb.org/Deployment/ Docker]
 +
* [https://www.grampsweb.org/LetsEncrypt/ Let's Encrypt and Docker Compose]
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 07:41, 23 September 2025

Gnome-important.png
Before upgrading your distribution

Use your earlier version of Gramps to backup your Family Trees to the hardy and portable XML format1.

Macos 200x200.png

Application package

The application package is the recommended way of installing Gramps on macOS.

First read the before installation instructions.

Tested for compatibility with Apple macOS/Mac OS X versions 10.13 (High Sierra) through 14 (Sonoma). Help determining your Operating System version can be found in the HT201260 Apple Support article.

After download: Double-click the .dmg file to mount the disk (note: your browser may do this for you automatically). Next, drag the Gramps application to your application folder and double-click to launch it. (For Apple Mac OS X, alternatively, you can click and hold on the disk icon at the top of the window of the mounted disk, and then option-drag to the Applications folder. This will create a new folder containing all the files, including the README and NEWS.)

Normally, when you try to load your old Family Tree you can allow it to be upgraded if necessary, and it will be opened. Should this fail for any reason, Create a new Family Tree and Import the back-up into this new Tree.


Adding additional Spell Checking languages on macOS

Tango-Dialog-information.png

Gramps uses a different spell checker than the one provided by Mac OS X, with different spelling dictionary requirements. We can't easily provide dictionaries for all of the supported languages in the bundle, but they're easily downloaded from OpenOffice.org's website. Download the language you want and save it, then navigate to the download in Finder. Most browsers have a downloads window that offers "Show in Finder" in its context menu. Change the file extension from oxt to zip, then from the context menu select Open with... Archive Utility to decompress it. In the decompressed folder or perhaps in a subfolder you'll find the dictionary files in pairs, foo.aff and foo.dic. Some languages have more than one pair with a README file to explain why. Select a pair and copy it to /Library/Dictionaries (you'll have to authenticate with an administrator id and password), and if 'foo' isn't already a language or locale code, make it one. For example, the French package includes several pairs with names like fr-moderne.aff and fr-moderne.dic. The spell checker doesn't recognize those names, so when you copy them to /Library/Dictionaries you must rename them to fr.aff and fr.dic or fr_FR.aff and fr_FR.dic. You can have more than one dictionary pair installed if you use several languages, but one must match the language you use for Gramps or spell checking won't be enabled at all.



MacPorts

MacPorts is a package manager for Apple Mac.

Why use the version from MacPorts? Certain plugins or addons require additional supporting software in order to operate. With MacPorts, you can install such software easily (most of the time; there could be exceptions). With the official .dmg installer, installing such additional software is more difficult or impossible.

The Prequisites Checker can identify if any addons have been installed that require such additional software.


Homebrew

The macOS application bundle can also be installed via the Homebrew package manager as a cask. Note that this is not a Homebrew build, it is a repackaging of the same Gramps.app provided in the above dmg. It does not depend on or use any of the Homebrew-built libraries.

Homebrew is an open-source package manager for macOS (and Linux).

See https://github.com/homebrew/


Notes

Backup to Gramps XML format when updating. Although Gramps reads and writes GEDCOM 5.5.1 format fluently (because it is the de facto format for genealogical data interchange), never depend on such a rudimentary format for archiving your research. GEDCOM cannot store all the intricacies found in Gramps data. Always backup with the more robust Gramps XML format.

Menubar - "Family Trees > Make Backup..."

You will find a Make Backup... option in the Family Trees menu of recent Gramps versions. Alternately, use Export... in the same menu but deselect the privacy and filtering options in the Exporter Assistant to avoid omission of any data.

See: How to make a backup

See also

Installing Gramps for Desktops

Installation instructions specific to the different OSes are on the Linux 32x32.png, Windows 32x32.png,Macos 200x200.png and Bsd daemon.png pages.

GitHub Gramps for Desktops Releases

Wiki pages

Installing Gramps Web for online collaboration

Gramps Web is a frontend for a hosted instance of Gramps