Archive and distribute your base on a removable media (CD-ROM)

From GeneWeb
Revision as of 15:04, 20 April 2016 by Henri83 (Talk | contribs) (Unix and Mac OSX)

Jump to: navigation, search
150px-Geographylogo svg.png Language: English • français

Archiving your GeneWeb base on a permanent and removable media such as a CD-ROM protects your data and facilitates sharing withour requiring GeneWeb installation.

Archiving on a write-once media

Here are the steps necessary to construct an autonomous CD_ROM containing one or several bases and the necessary executables.

  • Clean your base(s), in particular if you have made several updates.
  • Launch update_nldb (notes index construction) and consanguinity computation if you have requested their display on personal pages (show_consang=yes, see configuration)
  • Connect to your base, and perform one relationship conputing (path between two individuals). The first occurence of a relationship computing computes a file (tstab) which optimises further relationship computings. When on a CD-ROM, creation of this file would not be possible, but its absence does not prevent relationship computing from happening.
  • Create a Staging folder whose entire content will be written on the removable media. In this folder, place copies of:
  1. The gwd executable file (on windows systems, it usually has .exe extension), and its .arg argument file. Make sure that this files has the proper executable property.
  2. Any tags.txt (see tags) and file.auth (see access) files needed for proper execution of your base.
  3. The bases folders whose extensions are .gwb.
  4. The .gwf configuration file(s) associated with your bases.
  5. The folders etc (template files), images (portraits), lang (language dictionnaries) and src (text and image files). They must be located iin the same folder as gwd.
In the .gwf configuration file associated with your base(s), add the line wizard_passwd=xyz
  • If your base proposes portraits for persons, install the corresponding .jpg files in a images/mybase folder (see example below).
  • Important step: gwd builds several temporary files (in its working directory by default). If executed from a non writable media, a parameter must indicate where temporary files can be written. These files are of modest size, and can be deleted with no harm.
This parameter is provided in the gwd.arg or in the command launching gwd (see example below):
  • Before writing out to your CD-ROM, make a final test, verifying that while the Staging folder is write protected, you still have complete functionality.
Launching GeneWeb should be done by clicking on the appropriate gwd.bat, gwd.sh or gwd.command file. Make sure that those files have the proper executable property.
After launch, opening your base will be done by entering http://127.0.0.1:2317/mybase1 into the URL line of your browser, or by clicking on a link of a start.html page that you may have prepared.
  • Write-out the content of Staging to the removable media.

Typicall structure for a multi-platform, multi-base distribution

This structure can obviously be simplified in the case of a single platform and/or single base.

  • directory Staging
    • directory Windows
      • directory bases
        • directory mybase1.gwb
        • file mybase1.gwf
        • directory mybase2.gwb
        • file mybase2.gwf
        • file friends1.auth
        • file friends2.auth
        • directory etc
          • directory mybase1
            • file trl.txt # base specific template files
        • directory src
          • directory mybase1
            • file file1.txt # files included with m=SRC;v=file1
            • directory images
              • file image1.jpg # images obtained with m=IMH;s=image1.jpg
        • directory images
          • directory mybase1
            • file first_name.oc.last_name.jpg # portraits displayed on personal page
        • directory lang
          • directory mybase1
            • file file1.txt # base specific language files
      • directory gw
        • directory etc # template files
        • directory images # pictograms and icons
        • directory lang # language dictionnaries
        • file gwd.exe # executable
        • file tags.txt # authorised HTML tags
        • file gwd.arg # arguments for gwd launch
      • file README # Some explanations for install and launch
      • file start.html # Some optionnal start file containing the various <a href="http://127.0.0.1:2317/mybase1">MyBase1</a> lines
      • file gwd.bat # gwd launch file
    • directory Linux
      • # same structure with OS specific changes (Binaries, line-end for text files, ...!!)
      • file gwd.sh # gwd launch file
    • directory Mac-OSX
      • # same structure with OS specific changes (Binaries, line-end for text files, ...!!)
      • file gwd.command # gwd launch file

With the structure as above, the content of gwd.bat, gwd.command and the two gwd.arg files should be:

Windows

Note that arguments can be passed to gwd either through the .arg file, or through the launch command line.

  • gwd.arg
-bd
 ../bases
-wd
 c:\temp\geneweb
  • gwd.bat

to be completed

Unix and Mac OSX

  • gwd.arg
-bd
 ../bases
-wd
 /tmp/geneweb
  • gwd.command
#!/bin/sh
# Shutdown daemon allready running
killall gwd
cd `$(dirname "$0")`
cd ./bases
../gw/gwd -hd ../gw -bd . -wd /tmp/geneweb




GeneWeb Manual

Rembrandt Old Man Reading a Book.jpg

Use and manage genealogical databases

Technical annex