Changes

Jump to: navigation, search

Installation alternatives

869 bytes added, 02:30, 12 March 2015
Installing locally
== Introduction =={{man warn|Warning:|It is assumed that you know what you are doing. If you are trying to normally install stable Gramps version then see [[Installation]] page instead.}}
This page describes other possible ways of running GRAMPS, Gramps without necessarily installing it the conventional way. '''Warning:''' it is assumed that you know what you are doing. If you are note sure this means you don't know it. If you are trying to normally install stable GRAMPS version then see [[Installation]] page instead.
The two alternatives to the conventional installation are:
== Why install non-conventionally? ==
There might be many reasons you want to not conventionally install GRAMPSGramps. You might have heard about a new feature you want to try that hasn't been released yet. You might be interested in adding a new feature. You might be interested in getting under the hood to take a look around. In case you have a stable working version of GRAMPSGramps, you would not want to disturb that installation by installing something experimental on top of it.
== Common steps ==
Whether you want to run from the source directory or do a proper local or non-default install, you need first to get the source and configure it.
=== Get the source ===either from the [[Brief introduction to Git|Git repository]] or from the [http://sourceforge.net/projects/gramps/files/ released tarball] (in the latter case, unpack the tarball). Change to the <code>gramps34</code> directory (or whatever it is called for you): cd gramps34
Read [[Brief introduction to SVN]], and obtain == Running from the source code of the stable branch. At the moment, this is '''gramps2''' and is downloaded to a directory ''gramps2''==
=== Configuration ===Change This is the strategy in which just a bare minimum gets installed globally, to enable Gramps to the <start. The entirety of Gramps code>gramps2</code> will sit in your home directory: cd gramps2Execute the autogen script. This needs to be done the first time , right where you downloaded it, and any time files are added. ./autogenwill run from there.sh
== Running from the source directory = Bare minimum installation on Linux ===
This is First execute the strategy in which just a bare minimum gets installed globally, to enable gramps to start<code>./autogen. The entirety of GRAMPS sh</code will sit in > script. If your home directory, right where you downloaded it, system lacks autotools then use <code>./configure</code> instead. This needs to be done the first time and will run from thereany time files are added: ./autogen.sh
=== Bare Next, install the bare minimum installation ===files for Gramps.
''Note'': If you have a fairly recent stable GRAMPS Gramps version, you may be able to skip this step. If in doubt, try without it, and see if you get errors related to mime types or gconf schemas. If you do, you need to go through this part.
Change to the <code>data</code> directory, then run <code>make install</code> as a super-user (Ubuntu users will probably use <code>sudo</code>):
make install
=== Bare minimum installation on Windows=== Fundamentally all you need to run Gramps on Windows is the const.py file which is generated from the template named const.py.in. During generation, the Gramps version is placed in const.py. If you don't care about the version, you can just copy const.py.in to const.py. First, from a command prompt, cd into the directory where you downloaded or extraced the source files. Then, issue the following command:  copy src\const.py.in src\const.py === Running GRAMPS Gramps ===You can now start GRAMPS Gramps locally, by typing on the command line:
cd src
python gramps.py
Now you can edit files and run <code>python gramps.py</code> without mucking with your official installation of GRAMPSGramps.
'''Note''': You should '''NOT''' do ''make install'' with the SVN Git version, as this will install the unstable version globally. If you want a more recent version of GRAMPS Gramps globally, download '''a stable release''' from sourceforge following the [[Installation]] instructions.
=== Limitations ===
This way you should be able to run GRAMPS Gramps and be OK in most regards. You will probably not get the current translations because we did not install them properly.For that see:* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
== Installing locally ==
This is the 100% proper installation strategy that allows you to skip nothing and install into weird places. People do that either because they lack root access and cannot install the regular way, or because of their personal reasons (e.g. weird systems without /usr dir :-). If you fall into this category, start with the [httphttps://gramps.svn.sourceforgegithub.netcom/viewvcgramps-project/gramps/trunkblob/gramps2master/INSTALL?view=log INSTALL] file shipped with the source.
Most things in GRAMPS Gramps can be installed anywhere and GRAMPS Gramps will happily run from that location. The exceptions are:
* gconf schemas
* mime types
By default, the shared mime systems will look in these places:
# <code>/usr/share/mime</code>
# <code>/usr/local/share/mime</code>: (this may be broken on some systems)# <code>$HOME/.local/share/mime</code>: (this is a per-user setup, not system-wide)
Likewise, there's a number of ways to instruct the shared mime system to look in other places, but this is the whole other story. Since the first way does not work for you, you will go with something like:
--with-mime-dir=$HOME/.local/share/mime
--prefix=$HOME/my_gramps_path
A non-local install will also need to skip the scrollkeeper registration of the helpfiles:
--disable-scrollkeeper
Of course, your mileage may vary, because you may want to go a global install into <code>/src/weird/path</code> or whatever else you feel like doing. The only thing to worry about is that gconf schemas and mime types are properly found. So either install them in their default places, or maybe patch them to use your private paths.
 
== See also ==
* [[Gramps_4.1_Wiki_Manual_-_Command_Line#GRAMPSHOME |$GRAMPSHOME]]
* [[Translating_Gramps#.24GRAMPSI18N_.28for_your_locale.29| $GRAMPSI18N (for your locale) ]]
[[Category:Developers/General]]

Navigation menu