Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
({{version}} use to show current version / update instruction)
(Rough draft for Gramps 4.x)
(27 intermediate revisions by 9 users not shown)
Line 3: Line 3:
 
== Latest released version ==
 
== Latest released version ==
  
The latest released version is '''GRAMPS''' {{version}}. This version may not yet be available for installation on your platform. Please visit the [[Download]] page for more information.
+
The latest released version is '''Gramps''' {{version}}. This version may not yet be available for installation on your platform. Please visit the [[Download]] page for more information.
  
== Upgrading GRAMPS ==
+
== Upgrading Gramps ==
  
{{man warn|1=Warning|2=If you are '''Upgrading GRAMPS''' from a previous version you should first follow these intructions.}}
+
{{man warn|1=Warning|2=If you are '''Upgrading Gramps''' from a previous version you should first follow these intructions.}}
  
If you are '''Upgrading GRAMPS''' from a previous version you should first:
+
If you are '''Upgrading Gramps''' from a previous version you should first:
  
# Use your '''old version of GRAMPS''' to '''export''' your Family Trees to GRAMPS XML ('''uncheck privacy options''' on Exporter Assistant)
+
# Use your '''old version of Gramps''' to '''backup''' or '''export''' your Family Trees to GRAMPS XML (you find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but '''uncheck privacy options''' in the Exporter Assistant in order to export all data).
# '''Uninstall''' your old version of GRAMPS
+
# '''Uninstall''' your old version of Gramps
# '''Install''' the new version of GRAMPS by following the instructions below
+
# '''Install''' the new version of Gramps by following the instructions below
# '''Create''' a new Family Tree
+
# '''Open''' your existing Family tree.
# '''Import''' your old GRAMPS XML data
+
:# Normally, opening just works, and will upgrade your data if needed. If successfull, save the backup you took in a safe place.
 +
:# In case opening or upgrading your existing Family Tree failed, do the following:
 +
::#'''Create''' a new Family Tree
 +
::# '''Import''' your old Gramps XML data in this Family Tree
  
==Additional software GRAMPS can benefit from==
+
==Additional software Gramps can benefit from==
GRAMPS does not rely on the following programs, however, having them will increase your productivity:
+
Gramps does not rely on the following programs, however, having them will increase your productivity:
  
 
* '''Spell checking''': Installing gnome-python2-extras and python-enchant provides the gtkspell module and the enchant module, which adds spell checking in the notes
 
* '''Spell checking''': Installing gnome-python2-extras and python-enchant provides the gtkspell module and the enchant module, which adds spell checking in the notes
Line 32: Line 35:
  
 
==Linux==
 
==Linux==
===Automatic download and install of GRAMPS===
+
===Automatic download and install of Gramps===
Before downloading GRAMPS from this site, see if your operating system's repository makes the current '''Gramps {{version}}''' version available. You could also visit [http://sourceforge.net/projects/gramps/files/Stable/ GRAMPS stable on Sourceforge] and look at the version number of the top package.
+
Before downloading Gramps from this site, see if your operating system's repository makes the current '''Gramps''' {{version}} version available. You could also visit [http://sourceforge.net/projects/gramps/files/Stable/ Gramps stable on Sourceforge] and look at the version number of the top package.
  
 
To check what is available specifically for your Linux operating system some methods are listed below:
 
To check what is available specifically for your Linux operating system some methods are listed below:
Line 56: Line 59:
 
|}
 
|}
  
===Manual download and install of GRAMPS===
+
===Manual download and install of Gramps===
If your Linux operating systems repository does not have the current version, then you may be able to download it from this site. Some helpful users of GRAMPS have made packages for various systems. If you are lucky you'll find your system below. If it's missing you can contact the developers email list for advice.
+
If your Linux operating systems repository does not have the current version, then you may be able to download it from this site. Some helpful users of Gramps have made packages for various systems. If you are lucky you'll find your system below. If it's missing you can contact the developers email list for advice.
  
 
====Ubuntu and derivatives====
 
====Ubuntu and derivatives====
Repository packages for '''Ubuntu''' and derivatives (Kubuntu, Mephis, LinuxMint, ...): are available on [http://sourceforge.net/projects/gramps/files/Stable/ GRAMPS download page].
+
Repository packages for '''Ubuntu''' and derivatives (Kubuntu, Mephis, LinuxMint, ...): are available on [http://sourceforge.net/projects/gramps/files/Stable/ Gramps download page]. See [http://sourceforge.net/projects/gramps/files/OldFiles/ OldFiles] for archives.
 
+
{|{{prettytable}}
+
!Ubuntu (Version)
+
! GRAMPS<br>Release
+
!Download
+
|-
+
|<!-- Ubuntu (Version) --> (10.10)
+
|<!-- GRAMPS<br>Release -->3.3.0
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.3.0/gramps_3.3.0-1_Ubuntu.deb/download gramps_3.3.0-1.deb]
+
|-
+
|<!-- Ubuntu (Version) --> (10.04)
+
|<!-- GRAMPS<br>Release -->3.3.0
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.3.0/gramps_3.3.0-1_Ubuntu.deb/download gramps_3.3.0-1.deb]
+
|-
+
|<!-- Ubuntu (Version) --> (9.10)
+
|<!-- GRAMPS<br>Release -->3.2.2
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.2.2/gramps_3.2.2-1_ubuntu09.deb/download gramps_3.2.2-1_Ubuntu09.deb]
+
|-
+
|<!-- Ubuntu (Version) -->Jaunty Jackalope (9.04)
+
|<!-- GRAMPS<br>Release -->3.2.2
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.2.2/gramps_3.2.2-1_ubuntu09.deb/download gramps_3.2.2-1_Ubuntu09.deb]
+
|-
+
|<!-- Ubuntu (Version) -->Intrepid Ibex (8.10)
+
|<!-- GRAMPS<br>Release -->3.1.3
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.1.3/gramps-3.1.3-1_Ubuntu.deb/download gramps-3.1.3-1_Ubuntu.deb]
+
|-
+
|<!-- Ubuntu (Version) -->Hardy (8.04)
+
|<!-- GRAMPS<br>Release -->3.1.3
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.1.3/gramps-3.1.3-1_Ubuntu.deb/download gramps-3.1.3-1_Ubuntu.deb]
+
|-
+
|<!-- Ubuntu (Version) -->Gutsy (7.10)
+
|<!-- GRAMPS<br>Release -->3.0.3
+
|<!-- Download -->[http://sourceforge.net/project/showfiles.php?group_id=25770  gramps_3.0.3-1_ubuntu710.deb]
+
|-
+
|<!-- Ubuntu (Version) -->Feisty (7.04)
+
|<!-- GRAMPS<br>Release -->2.2.10
+
|<!-- Download -->Download [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps_2.2.10-1_all.deb]<br>and [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps-help_2.2.10-1_all.deb], and install with your package manager.
+
|-
+
|<!-- Ubuntu (Version) -->Dapper, Edgy<br> and earlier versions of Ubuntu
+
|<!-- GRAMPS<br>Release -->2.2.8
+
|<!-- Download -->Download [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps_2.2.8-1dapper1_all.deb]<br>and [http://sourceforge.net/project/showfiles.php?group_id=25770 gramps-help_2.2.8-1dapper1_all.deb], and install with your package manager.
+
|}
+
  
 
====Debian====
 
====Debian====
'''Debian''': the latest version should be in the ''unstable'' repository ([http://packages.debian.org/sid/gramps Sid Gramps]) and can be upgraded from your package manager. The ''testing'' repository is updated 10 days later (except near a new stable release), see [http://packages.debian.org/testing/gramps Testing Gramps]. Released versions of Debian (''etch'' and ''lenny'') contain older versions of GRAMPS, see the list of [http://packages.debian.org/search?keywords=gramps versions of GRAMPS in Debian].
+
'''Debian''': the latest version should be in the ''unstable'' repository ([http://packages.debian.org/sid/gramps Sid Gramps]) and can be upgraded from your package manager. The ''testing'' repository is updated 10 days later (except near a new stable release), see [http://packages.debian.org/testing/gramps Testing Gramps]. Released versions of Debian (''etch'' and ''lenny'') contain older versions of Gramps, see the list of [http://packages.debian.org/search?keywords=gramps versions of Gramps in Debian].
  
 
====SuSE====
 
====SuSE====
'''SuSE''': Richard Bos has been providing the GRAMPS releases for OpenSUSE. The repository for OpenSUSE 11.1 is available from [http://download.opensuse.org/repositories/Education/openSUSE_11.1/] or [http://download.opensuse.org/repositories/home:/cornelisbb/]. Note that at the time of writing this repository is not the same as that in the repository list as "Education" and must be added as a URL. The repository for 11.0 is [http://download.opensuse.org/repositories/Education/openSUSE_11.0/] and 10.3 is [http://download.opensuse.org/repositories/Education/openSUSE_10.3/]. For earlier versions of OpenSUSE (10.2) see the forum entry about [http://www.suseforums.net/index.php?s=22f80a050a1e3cffffd590db0813dea9&showtopic=28727&pid=152093&st=0&#entry152093 satisfying GRAMPS dependencies for SuSE with the ''rbos'' and SMART]. Also, there is [[OpenSUSE_RPM|an other alternative using openSUSE BuildService]].
+
'''SuSE''': Richard Bos has been providing the Gramps releases for OpenSUSE. The repository for OpenSUSE 11.1 is available from [http://download.opensuse.org/repositories/Education/openSUSE_11.1/] or [http://download.opensuse.org/repositories/home:/cornelisbb/]. Note that at the time of writing this repository is not the same as that in the repository list as "Education" and must be added as a URL. The repository for 11.0 is [http://download.opensuse.org/repositories/Education/openSUSE_11.0/] and 10.3 is [http://download.opensuse.org/repositories/Education/openSUSE_10.3/]. For earlier versions of OpenSUSE (10.2) see the forum entry about [http://www.suseforums.net/index.php?s=22f80a050a1e3cffffd590db0813dea9&showtopic=28727&pid=152093&st=0&#entry152093 satisfying Gramps dependencies for SuSE with the ''rbos'' and SMART]. Also, there is [[OpenSUSE_RPM|an other alternative using openSUSE BuildService]].
  
 
====Mandriva====
 
====Mandriva====
'''Mandriva''': Newer versions of GRAMPS are sometimes backported. To install backports you must enable the ''backports'' repository (make sure you understand the instructions on the [http://wiki.mandriva.com/en/Docs/Basic_tasks/Installing_and_removing_software#Advanced_use:_Backports_and_candidate_updates Mandriva wiki]). If the latest version is not in the ''backports'' repository you cab try the ''contrib'' repository.
+
'''Mandriva''': Newer versions of Gramps are sometimes backported. To install backports you must enable the ''backports'' repository (make sure you understand the instructions on the [http://wiki.mandriva.com/en/Docs/Basic_tasks/Installing_and_removing_software#Advanced_use:_Backports_and_candidate_updates Mandriva wiki]). If the latest version is not in the ''backports'' repository you cab try the ''contrib'' repository.
  
 
====Fedora====
 
====Fedora====
'''Fedora''': For Fedora look on the [http://sourceforge.net/projects/gramps/files/ GRAMPS download page] for a package containing ''fc'' with your number and ending with ''.rpm''. The alternative to installing from source is to [[fedora rpm|build a package]] from an rpm spec file, or install a binary from fedora testing.
+
'''Fedora''': For Fedora look on the [http://sourceforge.net/projects/gramps/files/ Gramps download page] for a package containing ''fc'' with your number and ending with ''.rpm''. The alternative to installing from source is to [[fedora rpm|build a package]] from an rpm spec file, or install a binary from fedora testing.
  
===Slackware===
+
====Slackware====
 
'''Slackware 13.0''': Gramps 3.2.5 is available via [http://www.linuxpackages.net/pkg_details.php?id=13368 LinuxPackages].
 
'''Slackware 13.0''': Gramps 3.2.5 is available via [http://www.linuxpackages.net/pkg_details.php?id=13368 LinuxPackages].
  
 
====Different GNU/Linux distributions====
 
====Different GNU/Linux distributions====
Different GNU/Linux distributions have other preferred ways to download and install packages for GRAMPS. Please read the installation instructions specific to your distribution before downloading.
+
Different GNU/Linux distributions have other preferred ways to download and install packages for Gramps. Please read the installation instructions specific to your distribution before downloading.
  
 
In all other cases, you must [http://sourceforge.net/projects/gramps/files/ download] the stable source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.
 
In all other cases, you must [http://sourceforge.net/projects/gramps/files/ download] the stable source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.
  
 
===Gnome and KDE===
 
===Gnome and KDE===
You can use both, but GRAMPS fits in better with GNOME.
+
You can use both, but Gramps fits in better with GNOME.
  
For KDE there are some minor issues due to some (GTK) issues outside of GRAMPS. Check the [[KDE page]] to know what these problems might be.
+
For KDE there are some minor issues due to some (GTK) issues outside of Gramps. Check the [[KDE page]] to know what these problems might be.
  
For GNOME, there are some issues due to some (ATK/GAIL) issues outside of GRAMPS. Check the [[Known_issues|Known issues]] to know what these problems might be.
+
For GNOME, there are some issues due to some (ATK/GAIL) issues outside of Gramps. Check the [[Known_issues|Known issues]] to know what these problems might be.
  
 
Also, you might look at [http://portland.freedesktop.org/wiki/ XdgUtils].
 
Also, you might look at [http://portland.freedesktop.org/wiki/ XdgUtils].
  
===GRAMPS on handhelds===
+
===Gramps on handhelds===
GRAMPS can run fine on some small-factor devices. Users have been successful in using GRAMPS on:  
+
Gramps can run fine on some small-factor devices. Users have been successful in using Gramps on:  
 
* [[Gramps on the Eee|Asus Eee PC]]
 
* [[Gramps on the Eee|Asus Eee PC]]
 
* [http://gramps-project.org/2011/01/gramps-mobile-interface-part-i/ Gramps Mobile Interface – part I]  & [http://gramps-project.org/2011/01/gramps-mobile-interface-%E2%80%93-part-ii/ part II]
 
* [http://gramps-project.org/2011/01/gramps-mobile-interface-part-i/ Gramps Mobile Interface – part I]  & [http://gramps-project.org/2011/01/gramps-mobile-interface-%E2%80%93-part-ii/ part II]
  
 
===Live Genealogy CD===
 
===Live Genealogy CD===
If you are interested in GRAMPS, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install [http://www.ubuntulinux.org/ Ubuntu 10.10] and GRAMPS from the CD anytime you like.
+
If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our [[Linux Genealogy CD]]. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install [http://www.ubuntulinux.org/ Ubuntu 10.10] and Gramps from the CD anytime you like.
  
 
==Windows, FreeBSD, Mac OS X, Solaris==
 
==Windows, FreeBSD, Mac OS X, Solaris==
 
===Windows===
 
===Windows===
Be aware there is a least 3 different ways you can install/use GRAMPS under windows. The method you choose will be dependent on ''your'' requirements and how much extra work you wish to put into setting up your environment.
+
Be aware there is a least 3 different ways you can install/use Gramps under windows. The method you choose will be dependent on ''your'' requirements and how much extra work you wish to put into setting up your environment.
 
In order of difficulty:
 
In order of difficulty:
* GRAMPS All-in-one installer (AIO) - While still under development the AIO installer has the lowest barrier of entry, see [[All In One Gramps Software Bundle for Windows]] for more information.
+
* Gramps All-in-one installer (AIO) - While still under development the AIO installer has the lowest barrier of entry, see [[All In One Gramps Software Bundle for Windows]] for more information.
* GRAMPS Portable - Allows you to Run GRAMPS from a portable drive and can be installed to the local hard drive see the [http://portableapps.com/apps/education/gramps_portable PortableApps.com Gramps Portable] page for more information.
+
* Gramps Portable - Allows you to Run Gramps from a portable drive and can be installed to the local hard drive see the [http://portableapps.com/apps/education/gramps_portable PortableApps.com Gramps Portable] page for more information.
* GRAMPS installer (minimal) - Stable installer, however it requires you to install all of GRAMPS dependencies prior to installing GRAMPS. see  [[Windows_installer#Installation | Installing Windows dependencies first.]]
+
* Gramps installer (minimal) - Stable installer, however it requires you to install all of Gramps dependencies prior to installing Gramps. see  [[Windows_installer#Installation | Installing Windows dependencies first.]]
  
  
 
More information of each of these installation methods can be seen on the [[download]] page.
 
More information of each of these installation methods can be seen on the [[download]] page.
  
*Additional information for Windows users is on page [[GRAMPS and Windows]].
+
*Additional information for Windows users is on page [[Gramps and Windows]].
  
 
====Building from source====
 
====Building from source====
  
Fortunately for users of Microsoft Windows, some users have made a [[Windows installer]]. So far there have not been any reports of serious differences between the official builds of GRAMPS and the Windows Installer, so the future looks promising, but please, use this at your own risk.
+
Fortunately for users of Microsoft Windows, some users have made a [[Windows installer]]. So far there have not been any reports of serious differences between the official builds of Gramps and the Windows Installer, so the future looks promising, but please, use this at your own risk.
  
 
===Mac OS X===
 
===Mac OS X===
  
====Ready-built binary application====
+
A ready-to-run application for Max OS X has been available since September 2009 for both Intel and PPC Apple computers. It is wise to back-up data carefully before using the application (especially if you are upgrading from a previous version of Gramps).
  
A port of Gramps to Mac has been available since September 2010. It is wise to back up data carefully before running it. It's available as a ready-built binary application for both Intel and PPC Macs.
+
Please read the installation instructions at [[Mac OS X:Application package]] before you use the program.
  
Mac for Gramps is described at [[Using GRAMPS on Apple Mac]].
+
===Free/OpenBSD and Solaris===
  
====Building from source====
+
For FreeBSD and Solaris there are experimental install instructions.
 +
* For FreeBSD use the [http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps /usr/ports/science/gramps] port. In case of error on FreeBSD 8.0, read ticket #{{bug|3228}}.
 +
* For OpenBSD use the [http://openports.se/misc/gramps gramps port]
 +
* Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the [[BSD Platforms|BSD page]] for details.
 +
* Gramps has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the [[Solaris Platforms|Solaris page]] for step-by-step details.
  
The pre-built binary version is also available as a build environment and can be built from scratch by any Mac with the Apple Xcode toolset.
+
==Installing Gramps from source code==
  
Macports and Fink versions of Gramps have been used. An overview of installing GRAMPS from source on the Mac is given under [[Mac_OS_X|Installing from source code on Mac OS X]].
+
Gramps 3.4.x is the main current version, and is available in packaged form for some distributions.
  
The latest version of MacPorts Gramps is '''{{version_MacPort}}'''.
+
Gramps 4.x is a new version that has different requirements. Installation of this version is described [[Installation#Gramps_4.x|here]]
The latest official stable fink version is '''1.0.10''' for Mac OS X 10.4.
+
The latest official unstable fink version is '''3.0.4''' for Mac OS X 10.5.
+
  
===Free/OpenBSD and Solaris===
+
=== Gramps 3.4.x ===
 
+
For FreeBSD and Solaris there are experimental install instructions.
+
* For FreeBSD use the [http://portsmon.freebsd.org/portoverview.py?category=science&portname=gramps /usr/ports/science/gramps] port. In case of error on FreeBSD 8.0, read [http://www.gramps-project.org/bugs/view.php?id=3228 ticket 3228].
+
* For OpenBSD use the [http://openports.se/misc/gramps gramps port]
+
* Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the [[BSD Platforms|BSD page]] for details.
+
* GRAMPS has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the [[Solaris Platforms|Solaris page]] for step-by-step details.
+
  
==Installing GRAMPS from source code==
+
==== General requirements ====
===General requirements===
+
  
GRAMPS {{version}} requires python 2.6 or greater, pygtk 2.16 or greater and librsvg2
+
Gramps {{version}} requires python 2.6 or greater, pygtk 2.16 or greater and librsvg2
  
 
==== Linux package requirements ====
 
==== Linux package requirements ====
Line 265: Line 221:
 
| osm-gps-map
 
| osm-gps-map
 
| Required for the Geography views
 
| Required for the Geography views
 +
|-
 +
| gtk2-engines-pixbuf
 +
|
 +
| Solves issue with 'Unable to locate theme engine in module_path: "pixmap"'
 
|}
 
|}
  
Line 275: Line 235:
 
</pre>
 
</pre>
  
====Obtaining the source====
+
==== Obtaining the source ====
  
 
There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/INSTALL?view=markup INSTALL] and [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/README?view=markup README] files accompanying the code. They come with the most recent information. Details on each download method:
 
There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/INSTALL?view=markup INSTALL] and [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/README?view=markup README] files accompanying the code. They come with the most recent information. Details on each download method:
Line 281: Line 241:
 
'''1. Download a stable version'''
 
'''1. Download a stable version'''
  
* The latest stable version of GRAMPS can be downloaded from the [http://sourceforge.net/projects/gramps/files/ GRAMPS SourceForge file area]. Eg: gramps-{{version}}.tar.gz. Extract this file into a directory:
+
* The latest stable version of Gramps can be downloaded from the [http://sourceforge.net/projects/gramps/files/ Gramps SourceForge file area]. Eg: gramps-{{version}}.tar.gz. Extract this file into a directory:
 
<code>
 
<code>
 
   tar xzvf gramps-zzz.tar.gz
 
   tar xzvf gramps-zzz.tar.gz
Line 287: Line 247:
 
   cd gramps-zzz
 
   cd gramps-zzz
 
</code>
 
</code>
* If you are interested in testing out the very latest development versions of GRAMPS, they can be obtained from SVN, see [[Brief introduction to SVN#Unstable_development:_.22trunk.22|Brief introduction to SVN]]. The SVN versions of GRAMPS are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!
+
* If you are interested in testing out the very latest development versions of Gramps, they can be obtained from SVN, see [[Brief introduction to SVN#Unstable_development:_.22trunk.22|Brief introduction to SVN]]. The SVN versions of Gramps are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!
  
 
'''2. Download from SVN'''
 
'''2. Download from SVN'''
Line 293: Line 253:
 
You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:
 
You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:
  
  svn co https://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.3.1 gramps
+
  svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.2/ gramps
  
for the most recent development version, see [[Running a development version of Gramps]].
+
for the most recent development version, see [[Getting started with Gramps Trunk]].
  
'''3. Tarball from SVN'''
+
==== Upgrading Gramps ====
  
You can get tarball for last sources.
+
If you have an older version of the Gramps source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.
  
* [http://gramps.svn.sourceforge.net/viewvc/gramps/branches/maintenance/gramps32/?view=tar 3.2.x]
+
Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. '''Do not install over the top of the old version.''' As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run<code>
 +
  make uninstall</code>
  
* [http://gramps.svn.sourceforge.net/viewvc/gramps/branches/maintenance/gramps33/?view=tar 3.3.x]
+
as root '''from where you installed the old version'''. Use your distribution's package manager to uninstall if your old version was installed as a package.
  
* [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/?view=tar Trunk]
+
'''Note that you should use your old Gramps version to export backup copies to GRAMPS XML before removing the old version.'''
  
====Upgrading GRAMPS====
+
==== Build on Linux ====
  
If you have an older version of the GRAMPS source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.
+
Gramps provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:<code>
 +
  ./autogen.sh  </code> # as regular user
 +
 
 +
This script will report any missing dependencies. Install these (see also INSTALL file). Building from source code typically requires that the development versions of the required libraries be installed. You might consider setting a prefix path with autogen.sh, see the INSTALL file for instructions. Standard install is in /usr/local.
 +
 
 +
Once a successful run of autogen.sh has been completed, you can run the typical make procedure. <code>
 +
  make </code> # as regular user
 +
 
 +
then <code>
 +
  make install </code> # as root
 +
 
 +
Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a <code>--prefix=</code> and a <code>--with-mime-dir=</code> argument to <code>autogen.sh</code>.
 +
 
 +
==== Mac OS X:Build from source ====
 +
 
 +
There are several different ways of building Gramps from source on Mac OS X. An overview of building from source is given at [[Mac OS X:Build from source]].
 +
 
 +
[[Mac OS X:Build from source:MacPorts|Macports]] and [[Mac OS X:Build from source:fink|fink]] versions of Gramps have been used.
 +
 
 +
The latest version of MacPorts Gramps is '''{{version_MacPort}}'''.
 +
The latest official unstable fink version is '''3.0.4''' for Mac OS X 10.5 on both PPC and Intel.
 +
There is currently no official stable fink version of Gramps. (As at February 2012)
 +
 
 +
Instructions for building the pre-built binary version (Mac OX X Application package) are given at [[Mac OS X:Build from source:Application package]]. Some discussion about earlier attempts is at [[Mac OS X:Build from source:gtk-osx]] with bugs reported at [[Mac OS X:Build from source:gtk-osx:bugs]]
 +
 
 +
An older build approach is given at [[Mac OS X:Build from source:Native OS X]].
 +
 
 +
=== Gramps 4.x ===
 +
 
 +
THIS IS ONLY A ROUGH DRAFT AND NEEDS UPDATING FOR Gramps 4.x
 +
 
 +
==== General requirements ====
 +
 
 +
Gramps 4.x requires python 2.? or greater, pygtk 2.? or greater and librsvg2
 +
 
 +
==== Linux package requirements ====
 +
 
 +
Required
 +
 
 +
{|{{Prettytable}}
 +
|-
 +
!Debian      /Ubuntu
 +
!Fedora      /Redhat
 +
!Comment
 +
|-
 +
|python
 +
|python
 +
|Required (needs version 2.? or later)
 +
|-
 +
|python-gtk2
 +
|pygtk2
 +
|Required (needs 2.? or greater)
 +
|-
 +
|[http://docs.python.org/library/bsddb.html BSDDB]
 +
|[http://docs.python.org/library/bsddb.html BSDDB]
 +
|Current backend
 +
|-
 +
|xdg-utils
 +
|xdg-utils
 +
|Required for Gramps-3.1.x or later
 +
|}
 +
 
 +
Required for building
 +
 
 +
{|{{Prettytable}}
 +
|-
 +
!Debian      /Ubuntu
 +
!Fedora      /Redhat
 +
!Comment
 +
|-
 +
|librsvg2-common
 +
|librsvg2
 +
|Required for building
 +
|-
 +
|libglib2.0-dev
 +
|glib2-devel
 +
|Required for building
 +
|-
 +
|
 +
|librsvg2-devel
 +
|Required for building
 +
|-
 +
|intltool
 +
|intltool
 +
|Required for building
 +
|-
 +
|
 +
|gcc make gettext
 +
|Required for building
 +
|}
 +
 
 +
Strongly recommended
 +
 
 +
{|{{Prettytable}}
 +
|-
 +
!Debian      /Ubuntu
 +
!Fedora      /Redhat
 +
!Comment
 +
|-
 +
|
 +
|
 +
| osmgsmap
 +
|-
 +
| graphviz
 +
| graphviz graphviz-python
 +
| Required for some reports and views
 +
|-
 +
|
 +
|
 +
| PyICU
 +
|}
 +
 
 +
Optional
 +
 
 +
{|{{Prettytable}}
 +
|-
 +
!Debian      /Ubuntu
 +
!Fedora      /Redhat
 +
!Comment
 +
|-
 +
|python-gtkspell
 +
|gnome-python2-gtkspell
 +
|Suggested for running (spell check).  Included in the python-gnome2-extras package in older Debian distributions.
 +
|-
 +
|rcs
 +
|rcs
 +
|Suggested for running
 +
|-
 +
| python-webkit python-gtkmozembed
 +
| WebKitgtk pywebkitgtk
 +
| Required for the HTML view
 +
|-
 +
| python-pygoocanvas
 +
| goocanvas pygoocanvas
 +
| Required for [[Graph View]]
 +
|-
 +
|
 +
| Django
 +
| Required for http://gramps-connect.org [[Gramps-Connect: Introduction|Gramps-Connect]]
 +
|-
 +
| python-pyexiv2
 +
| pyexiv2
 +
| Required for the Metadata Viewer and Edit Exif Metadata gramplets
 +
|-
 +
| libosmgpsmap-dev python-osmgpsmap
 +
| osm-gps-map
 +
| Required for the Geography views
 +
|-
 +
| gtk2-engines-pixbuf
 +
|
 +
| Solves issue with 'Unable to locate theme engine in module_path: "pixmap"'
 +
|}
 +
 
 +
Under Redhat/Fedora you can install all of the above with:
 +
 
 +
<pre>
 +
sudo yum install python pygtk2 xdg-utils rcs gnome-python2-gtkspell librsvg2 \
 +
  librsvg2-devel intltool gnome-doc-utils gcc automake autoconf autogen \
 +
gettext WebKitgtk pywebkitgtk goocanvas pygoocanvas graphviz graphviz-python \ Django pyexiv2 inkscape ImageMagick
 +
</pre>
 +
 
 +
====Obtaining the source====
 +
 
 +
There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/INSTALL?view=markup INSTALL] and [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/README?view=markup README] files accompanying the code. They come with the most recent information. Details on each download method:
 +
 
 +
'''1. Download a stable version'''
 +
 
 +
* The latest stable version of Gramps can be downloaded from the [http://sourceforge.net/projects/gramps/files/ Gramps SourceForge file area]. Eg: gramps-{{version}}.tar.gz. Extract this file into a directory:
 +
<code>
 +
  tar xzvf gramps-zzz.tar.gz
 +
</code> and then go into this directory:<code>
 +
  cd gramps-zzz
 +
</code>
 +
* If you are interested in testing out the very latest development versions of Gramps, they can be obtained from SVN, see [[Brief introduction to SVN#Unstable_development:_.22trunk.22|Brief introduction to SVN]]. The SVN versions of Gramps are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!
 +
 
 +
'''2. Download from SVN'''
 +
 
 +
You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:
 +
 
 +
svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0/ gramps
 +
 
 +
for the most recent development version, see [[Getting started with Gramps Trunk]].
 +
 
 +
====Upgrading Gramps====
 +
 
 +
If you have an older version of the Gramps source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.
  
 
Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. '''Do not install over the top of the old version.''' As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run<code>
 
Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. '''Do not install over the top of the old version.''' As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run<code>
Line 316: Line 462:
 
as root '''from where you installed the old version'''. Use your distribution's package manager to uninstall if your old version was installed as a package.
 
as root '''from where you installed the old version'''. Use your distribution's package manager to uninstall if your old version was installed as a package.
  
'''Note that you should use your old GRAMPS version to export backup copies to GRAMPS XML before removing the old version.'''
+
'''Note that you should use your old Gramps version to export backup copies to GRAMPS XML before removing the old version.'''
  
===Linux===
+
==== Build on Linux ====
  
GRAMPS provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:<code>
+
Gramps provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:<code>
 
   ./autogen.sh  </code> # as regular user
 
   ./autogen.sh  </code> # as regular user
  
Line 332: Line 478:
  
 
Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a <code>--prefix=</code> and a <code>--with-mime-dir=</code> argument to <code>autogen.sh</code>.
 
Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a <code>--prefix=</code> and a <code>--with-mime-dir=</code> argument to <code>autogen.sh</code>.
 +
 +
=== See also ===
 +
* $GRAMPSHOME on [[Gramps 3.4 Wiki Manual - Command Line#Environment variables]]
 +
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
 +
* [[Installation_alternatives]]
 +
* [[Translating_Gramps#Installing_your_translation]]
 +
* [[Howto:Change_the_language_of_reports#Run_GRAMPS_in_a_different_language]]
 +
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Developers/Installation]]
 
[[Category:Developers/Installation]]
 
[[Category:Developers/Packaging]]
 
[[Category:Developers/Packaging]]

Revision as of 11:06, 29 March 2013

Latest released version

The latest released version is Gramps 4.0.3. This version may not yet be available for installation on your platform. Please visit the Download page for more information.

Upgrading Gramps

Gnome-important.png
Warning

If you are Upgrading Gramps from a previous version you should first follow these intructions.

If you are Upgrading Gramps from a previous version you should first:

  1. Use your old version of Gramps to backup or export your Family Trees to GRAMPS XML (you find backup in the Family Tree menu of recent Gramps versions, otherwise use export in the same menu but uncheck privacy options in the Exporter Assistant in order to export all data).
  2. Uninstall your old version of Gramps
  3. Install the new version of Gramps by following the instructions below
  4. Open your existing Family tree.
  1. Normally, opening just works, and will upgrade your data if needed. If successfull, save the backup you took in a safe place.
  2. In case opening or upgrading your existing Family Tree failed, do the following:
  1. Create a new Family Tree
  2. Import your old Gramps XML data in this Family Tree

Additional software Gramps can benefit from

Gramps does not rely on the following programs, however, having them will increase your productivity:

  • Spell checking: Installing gnome-python2-extras and python-enchant provides the gtkspell module and the enchant module, which adds spell checking in the notes
  • Graphviz, Inkscape: Gramps can make nice Genealogical trees (relationship graphs). These are generated by the Graphviz package, which defines a code (dot), as well as programs to produce graphs (dotty, to be called from command line). This gives you as researcher most power over how your tree will look, but has a learning curve. An alternative is to make a graphical report, converting the tree to an svg file, which you then can open/edit/refine in eg Inkscape.
  • ttf-freefont: Useful as a font that supports a large subset of the unicode and is a true type. This works well with both print and graphviz output.
  • XdgUtils is a set of command line tools that assist applications with a variety of desktop integration tasks. About half of the tools focus on tasks commonly required during the installation of a desktop application and the other half focuses on integration with the desktop environment while the application is running. Even if the desktop components of your application are limited to an installer, configuration or management tool, Xdg-utils provides you with an easy way to enhance the usage experience of your customers by improving the integration of these components in the user's environment.
  • pyexiv2 is a module that allows Gramps to read and write metadata embedded in image files. It is used in the Metadata Viewer and Edit Exif Metadata gramplets.
  • osmgpsmap is a library which provides GPS mapping functionality. It is used in the Geography views.

Other packages might also be useful:

  • desktop-file-utils: see list of programs to open a media file on right click on an image

Linux

Automatic download and install of Gramps

Before downloading Gramps from this site, see if your operating system's repository makes the current Gramps 4.0.3 version available. You could also visit Gramps stable on Sourceforge and look at the version number of the top package.

To check what is available specifically for your Linux operating system some methods are listed below:

Linux Operating System Command Line
Debian based systems
(Ubuntu & variants, Mepis,...)
sudo apt-get install gramps
Gentoo (and Sabayon) sudo emerge gramps
Mandriva sudo urpmi gramps
Redhat based systems
(Fedora, CentOS...)
sudo yum install gramps
OpenSUSE sudo zypper install gramps

Manual download and install of Gramps

If your Linux operating systems repository does not have the current version, then you may be able to download it from this site. Some helpful users of Gramps have made packages for various systems. If you are lucky you'll find your system below. If it's missing you can contact the developers email list for advice.

Ubuntu and derivatives

Repository packages for Ubuntu and derivatives (Kubuntu, Mephis, LinuxMint, ...): are available on Gramps download page. See OldFiles for archives.

Debian

Debian: the latest version should be in the unstable repository (Sid Gramps) and can be upgraded from your package manager. The testing repository is updated 10 days later (except near a new stable release), see Testing Gramps. Released versions of Debian (etch and lenny) contain older versions of Gramps, see the list of versions of Gramps in Debian.

SuSE

SuSE: Richard Bos has been providing the Gramps releases for OpenSUSE. The repository for OpenSUSE 11.1 is available from [1] or [2]. Note that at the time of writing this repository is not the same as that in the repository list as "Education" and must be added as a URL. The repository for 11.0 is [3] and 10.3 is [4]. For earlier versions of OpenSUSE (10.2) see the forum entry about satisfying Gramps dependencies for SuSE with the rbos and SMART. Also, there is an other alternative using openSUSE BuildService.

Mandriva

Mandriva: Newer versions of Gramps are sometimes backported. To install backports you must enable the backports repository (make sure you understand the instructions on the Mandriva wiki). If the latest version is not in the backports repository you cab try the contrib repository.

Fedora

Fedora: For Fedora look on the Gramps download page for a package containing fc with your number and ending with .rpm. The alternative to installing from source is to build a package from an rpm spec file, or install a binary from fedora testing.

Slackware

Slackware 13.0: Gramps 3.2.5 is available via LinuxPackages.

Different GNU/Linux distributions

Different GNU/Linux distributions have other preferred ways to download and install packages for Gramps. Please read the installation instructions specific to your distribution before downloading.

In all other cases, you must download the stable source package (the file ending with '.tar.gz') and install GRAMPS manually. See the section about installing from source for details.

Gnome and KDE

You can use both, but Gramps fits in better with GNOME.

For KDE there are some minor issues due to some (GTK) issues outside of Gramps. Check the KDE page to know what these problems might be.

For GNOME, there are some issues due to some (ATK/GAIL) issues outside of Gramps. Check the Known issues to know what these problems might be.

Also, you might look at XdgUtils.

Gramps on handhelds

Gramps can run fine on some small-factor devices. Users have been successful in using Gramps on:

Live Genealogy CD

If you are interested in Gramps, but are afraid to actually install it or unable to install it (not your PC, windows, no internet at home, work laptop, ...), then try out our Linux Genealogy CD. It runs without installing on the hard disk and contains a collection of open source, free, genealogy programs. You can then install Ubuntu 10.10 and Gramps from the CD anytime you like.

Windows, FreeBSD, Mac OS X, Solaris

Windows

Be aware there is a least 3 different ways you can install/use Gramps under windows. The method you choose will be dependent on your requirements and how much extra work you wish to put into setting up your environment. In order of difficulty:


More information of each of these installation methods can be seen on the download page.

Building from source

Fortunately for users of Microsoft Windows, some users have made a Windows installer. So far there have not been any reports of serious differences between the official builds of Gramps and the Windows Installer, so the future looks promising, but please, use this at your own risk.

Mac OS X

A ready-to-run application for Max OS X has been available since September 2009 for both Intel and PPC Apple computers. It is wise to back-up data carefully before using the application (especially if you are upgrading from a previous version of Gramps).

Please read the installation instructions at Mac OS X:Application package before you use the program.

Free/OpenBSD and Solaris

For FreeBSD and Solaris there are experimental install instructions.

  • For FreeBSD use the /usr/ports/science/gramps port. In case of error on FreeBSD 8.0, read ticket #3228.
  • For OpenBSD use the gramps port
  • Installing on BSD is as straightforward as on Linux, apart from some minor issues like tools having different names. See the BSD page for details.
  • Gramps has been successfully installed from source on both Solaris 10 (SPARC) and OpenSolaris X86 (2008.05). Please see the Solaris page for step-by-step details.

Installing Gramps from source code

Gramps 3.4.x is the main current version, and is available in packaged form for some distributions.

Gramps 4.x is a new version that has different requirements. Installation of this version is described here

Gramps 3.4.x

General requirements

Gramps 4.0.3 requires python 2.6 or greater, pygtk 2.16 or greater and librsvg2

Linux package requirements

Debian /Ubuntu Fedora /Redhat Comment
python python Required (needs version 2.6 or later)
python-gtk2 pygtk2 Required (needs 2.16 or greater)
BSDDB BSDDB Current backend
librsvg2-common librsvg2 Required for building
libglib2.0-dev glib2-devel Required for building
librsvg2-devel Required for building
intltool intltool Required for building
gcc make gettext Required for building
xdg-utils xdg-utils Required for Gramps-3.1.x or later
rcs rcs Suggested for running
python-gtkspell gnome-python2-gtkspell Suggested for running (spell check). Included in the python-gnome2-extras package in older Debian distributions.
python-webkit python-gtkmozembed WebKitgtk pywebkitgtk Required for the HTML view
python-pygoocanvas goocanvas pygoocanvas Required for Graph View
graphviz graphviz graphviz-python Required for some reports and views
Django Required for http://gramps-connect.org Gramps-Connect
python-pyexiv2 pyexiv2 Required for the Metadata Viewer and Edit Exif Metadata gramplets
libosmgpsmap-dev python-osmgpsmap osm-gps-map Required for the Geography views
gtk2-engines-pixbuf Solves issue with 'Unable to locate theme engine in module_path: "pixmap"'

Under Redhat/Fedora you can install all of the above with:

sudo yum install python pygtk2 xdg-utils rcs gnome-python2-gtkspell librsvg2 \
  librsvg2-devel intltool gnome-doc-utils gcc automake autoconf autogen \
gettext WebKitgtk pywebkitgtk goocanvas pygoocanvas graphviz graphviz-python \ Django pyexiv2 inkscape ImageMagick

Obtaining the source

There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the INSTALL and README files accompanying the code. They come with the most recent information. Details on each download method:

1. Download a stable version

  • The latest stable version of Gramps can be downloaded from the Gramps SourceForge file area. Eg: gramps-4.0.3.tar.gz. Extract this file into a directory:

  tar xzvf gramps-zzz.tar.gz

and then go into this directory:

  cd gramps-zzz

  • If you are interested in testing out the very latest development versions of Gramps, they can be obtained from SVN, see Brief introduction to SVN. The SVN versions of Gramps are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!

2. Download from SVN

You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:

svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-3.4.2/ gramps

for the most recent development version, see Getting started with Gramps Trunk.

Upgrading Gramps

If you have an older version of the Gramps source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.

Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. Do not install over the top of the old version. As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run

 make uninstall

as root from where you installed the old version. Use your distribution's package manager to uninstall if your old version was installed as a package.

Note that you should use your old Gramps version to export backup copies to GRAMPS XML before removing the old version.

Build on Linux

Gramps provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:

 ./autogen.sh   # as regular user

This script will report any missing dependencies. Install these (see also INSTALL file). Building from source code typically requires that the development versions of the required libraries be installed. You might consider setting a prefix path with autogen.sh, see the INSTALL file for instructions. Standard install is in /usr/local.

Once a successful run of autogen.sh has been completed, you can run the typical make procedure.

 make  # as regular user

then

 make install  # as root

Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a --prefix= and a --with-mime-dir= argument to autogen.sh.

Mac OS X:Build from source

There are several different ways of building Gramps from source on Mac OS X. An overview of building from source is given at Mac OS X:Build from source.

Macports and fink versions of Gramps have been used.

The latest version of MacPorts Gramps is 3.4.7. The latest official unstable fink version is 3.0.4 for Mac OS X 10.5 on both PPC and Intel. There is currently no official stable fink version of Gramps. (As at February 2012)

Instructions for building the pre-built binary version (Mac OX X Application package) are given at Mac OS X:Build from source:Application package. Some discussion about earlier attempts is at Mac OS X:Build from source:gtk-osx with bugs reported at Mac OS X:Build from source:gtk-osx:bugs

An older build approach is given at Mac OS X:Build from source:Native OS X.

Gramps 4.x

THIS IS ONLY A ROUGH DRAFT AND NEEDS UPDATING FOR Gramps 4.x

General requirements

Gramps 4.x requires python 2.? or greater, pygtk 2.? or greater and librsvg2

Linux package requirements

Required

Debian /Ubuntu Fedora /Redhat Comment
python python Required (needs version 2.? or later)
python-gtk2 pygtk2 Required (needs 2.? or greater)
BSDDB BSDDB Current backend
xdg-utils xdg-utils Required for Gramps-3.1.x or later

Required for building

Debian /Ubuntu Fedora /Redhat Comment
librsvg2-common librsvg2 Required for building
libglib2.0-dev glib2-devel Required for building
librsvg2-devel Required for building
intltool intltool Required for building
gcc make gettext Required for building

Strongly recommended

Debian /Ubuntu Fedora /Redhat Comment
osmgsmap
graphviz graphviz graphviz-python Required for some reports and views
PyICU

Optional

Debian /Ubuntu Fedora /Redhat Comment
python-gtkspell gnome-python2-gtkspell Suggested for running (spell check). Included in the python-gnome2-extras package in older Debian distributions.
rcs rcs Suggested for running
python-webkit python-gtkmozembed WebKitgtk pywebkitgtk Required for the HTML view
python-pygoocanvas goocanvas pygoocanvas Required for Graph View
Django Required for http://gramps-connect.org Gramps-Connect
python-pyexiv2 pyexiv2 Required for the Metadata Viewer and Edit Exif Metadata gramplets
libosmgpsmap-dev python-osmgpsmap osm-gps-map Required for the Geography views
gtk2-engines-pixbuf Solves issue with 'Unable to locate theme engine in module_path: "pixmap"'

Under Redhat/Fedora you can install all of the above with:

sudo yum install python pygtk2 xdg-utils rcs gnome-python2-gtkspell librsvg2 \
  librsvg2-devel intltool gnome-doc-utils gcc automake autoconf autogen \
gettext WebKitgtk pywebkitgtk goocanvas pygoocanvas graphviz graphviz-python \ Django pyexiv2 inkscape ImageMagick

Obtaining the source

There are two ways to get the source code: download a stable version source, or checkout the source from svn. Please, now is the time to read the INSTALL and README files accompanying the code. They come with the most recent information. Details on each download method:

1. Download a stable version

  • The latest stable version of Gramps can be downloaded from the Gramps SourceForge file area. Eg: gramps-4.0.3.tar.gz. Extract this file into a directory:

  tar xzvf gramps-zzz.tar.gz

and then go into this directory:

  cd gramps-zzz

  • If you are interested in testing out the very latest development versions of Gramps, they can be obtained from SVN, see Brief introduction to SVN. The SVN versions of Gramps are potentially very dangerous as they have not been extensively tested - especially the "trunk" version which contains features that may still be partly implemented. Be aware that they may be prone to crashing and cause extensive data loss. Please use with extreme caution - and only ever on a copy of your data!

2. Download from SVN

You can get a branch version (similar as above) or the latest bleeding-edge version through SVN, such as:

svn co https://svn.code.sf.net/p/gramps/code/tags/gramps-4.0.0/ gramps

for the most recent development version, see Getting started with Gramps Trunk.

Upgrading Gramps

If you have an older version of the Gramps source code installed you need to make a decision what you want to do with it before installing a later version. If you wish to keep the old version, make sure that you read the instructions in the INSTALL file regarding the use of the --prefix option to specify where the new version gets installed.

Should you just want to do a straightforward replacement instead, make sure that you remove the older version before you install the new version. Do not install over the top of the old version. As new versions of Gramps are developed, some functionality is occasionally rewritten in different ways. If you install over the top of an existing installation you run the risk that the old code left behind from the old version may be used instead of the new, sometimes with unintended consequences. If you installed from source, the best way of removing the old version is to run

 make uninstall

as root from where you installed the old version. Use your distribution's package manager to uninstall if your old version was installed as a package.

Note that you should use your old Gramps version to export backup copies to GRAMPS XML before removing the old version.

Build on Linux

Gramps provides a script that can be used to prepare the code for building. This script automatically calls the standard configure script:

 ./autogen.sh   # as regular user

This script will report any missing dependencies. Install these (see also INSTALL file). Building from source code typically requires that the development versions of the required libraries be installed. You might consider setting a prefix path with autogen.sh, see the INSTALL file for instructions. Standard install is in /usr/local.

Once a successful run of autogen.sh has been completed, you can run the typical make procedure.

 make  # as regular user

then

 make install  # as root

Local installation without root privileges is possible, instructions are available on the INSTALL file, most importantly one needs to supply a --prefix= and a --with-mime-dir= argument to autogen.sh.

See also