Difference between revisions of "Installation"

From Gramps
Jump to: navigation, search
m (Mac OS X:Build from source)
(37 intermediate revisions by 8 users not shown)
Line 1: Line 1:
 
{{languages}}
 
{{languages}}
  
== Latest released version ==
+
== Users ==
  
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.
+
Full download and installation instructions for [[Image:linux_32x32.png|link=Download#Linux]], [[Image:windows_32x32.png|link=Download#MS_Windows]] and [[Image:macosx_32x32.png|link=Download#Mac_OS_X]] are on the [[Download]] page.
  
== Upgrading Gramps ==
+
== Developers, packagers and advanced users ==
  
{{man warn|1=Warning|2=If you are '''Upgrading GRAMPS''' from a previous version you should first follow these intructions.}}
+
See instructions for [[Build from source|building from source]].
  
If you are '''Upgrading Gramps''' from a previous version you should first:
+
== See also ==
  
# Use your '''old version of GRAMPS''' to '''export''' your Family Trees to GRAMPS XML ('''uncheck privacy options''' on Exporter Assistant)
+
* $GRAMPSHOME on [[Gramps 3.4 Wiki Manual - Command Line#Environment variables]]
# '''Uninstall''' your old version of GRAMPS
+
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
# '''Install''' the new version of GRAMPS by following the instructions below
+
* [[Installation_alternatives]]
# '''Create''' a new Family Tree
+
* [[Translating_Gramps#Installing_your_translation]]
# '''Import''' your old GRAMPS XML data
+
* [[Howto:Change_the_language_of_reports#Run_GRAMPS_in_a_different_language]]
 
+
==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
+
* '''[http://www.graphviz.org 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.
+
* '''[http://portland.freedesktop.org/wiki/ 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.
+
* '''[http://tilloy.net/dev/pyexiv2/overview.html 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.
+
* '''[http://nzjrs.github.com/osm-gps-map/ osmgpsmap]''' is a library which provides GPS mapping functionality.  It is used in the Geography views.
+
 
+
Other packages might also be useful:
+
 
+
* '''[http://www.freedesktop.org/wiki/Software/desktop-file-utils 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''' {{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:
+
{|{{prettytable}}
+
!Linux Operating System
+
!Command Line
+
|-
+
|<!--Linux Operating System-->Debian based systems<br>(Ubuntu & variants, Mepis,...)
+
|<!--Command Line--><code>sudo apt-get install gramps</code>
+
|-
+
|<!--Linux Operating System-->Gentoo (and Sabayon)
+
|<!--Command Line--><code>sudo emerge gramps </code>
+
|-
+
|<!--Linux Operating System-->Mandriva
+
|<!--Command Line--><code>sudo urpmi gramps</code>
+
|-
+
|<!--Linux Operating System-->Redhat based systems<br>(Fedora, CentOS...)
+
|<!--Command Line--><code>sudo yum install gramps</code>
+
|-
+
|<!--Linux Operating System-->OpenSUSE
+
|<!--Command Line--><code>sudo zypper install gramps</code>
+
|}
+
 
+
===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 [http://sourceforge.net/projects/gramps/files/Stable/ GRAMPS download page].
+
 
+
{|{{prettytable}}
+
!Ubuntu (Version)
+
! GRAMPS<br>Release
+
!Download
+
|-
+
|<!-- Ubuntu (Version) --> (10.10)
+
|<!-- GRAMPS<br>Release -->3.3.1
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.3.1/gramps_3.3.1-1_Ubuntu.deb/download gramps_3.3.1-1.deb]  
+
|-
+
|<!-- Ubuntu (Version) --> (10.04)
+
|<!-- GRAMPS<br>Release -->3.3.1
+
|<!-- Download -->[http://sourceforge.net/projects/gramps/files/Stable/3.3.1/gramps_3.3.1-1_Ubuntu.deb/download gramps_3.3.1-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''': 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''': 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''': 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''': 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 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 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.
+
 
+
===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|Known issues]] to know what these problems might be.
+
 
+
Also, you might look at [http://portland.freedesktop.org/wiki/ XdgUtils].
+
 
+
===GRAMPS on handhelds===
+
GRAMPS can run fine on some small-factor devices. Users have been successful in using GRAMPS on:
+
* [[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]
+
 
+
===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.
+
 
+
==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:
+
* 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 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.
+
 
+
*Additional information for Windows users is on page [[GRAMPS and Windows]].
+
 
+
====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 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 (application package) for both Intel and PPC Macs.
+
 
+
Mac for Gramps is described at [[Mac OS X:Application package]].
+
 
+
===Free/OpenBSD and Solaris===
+
 
+
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===
+
 
+
GRAMPS {{version}} requires python 2.6 or greater, pygtk 2.16 or greater and librsvg2
+
 
+
==== Linux package requirements ====
+
{|{{Prettytable}}
+
|-
+
!Debian      /Ubuntu
+
!Fedora      /Redhat
+
!Comment
+
|-
+
|python
+
|python
+
|Required (needs version 2.6 or later)
+
|-
+
|python-gtk2
+
|pygtk2
+
|Required (needs 2.16 or greater)
+
|-
+
|[http://docs.python.org/library/bsddb.html BSDDB]
+
|[http://docs.python.org/library/bsddb.html 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: 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://gramps.svn.sourceforge.net/svnroot/gramps/tags/gramps-3.3.1 gramps
+
 
+
for the most recent development version, see [[Running a development version of Gramps]].
+
 
+
'''3. Tarball from SVN'''
+
 
+
You can get tarball for last sources.
+
 
+
* [http://gramps.svn.sourceforge.net/viewvc/gramps/branches/maintenance/gramps32/?view=tar 3.2.x]
+
 
+
* [http://gramps.svn.sourceforge.net/viewvc/gramps/branches/maintenance/gramps33/?view=tar 3.3.x]
+
 
+
* [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/?view=tar 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>
+
  make uninstall</code>
+
 
+
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.'''
+
 
+
===Linux===
+
 
+
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-build 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]].
+
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
[[Category:Developers/Installation]]
 
[[Category:Developers/Packaging]]
 

Revision as of 22:29, 2 February 2014

Users

Full download and installation instructions for Linux 32x32.png, Windows 32x32.png and Macosx 32x32.png are on the Download page.

Developers, packagers and advanced users

See instructions for building from source.

See also