PGVWiki - User contributions [en]

User talk:Laurie

2012-06-01T01:56:38Z

Ggpauly: /* delete a page */ new section

{{archive
| page = Archive 1
| from = December 2005
| to = December 2010
}}
==Installation Log==
[[User talk:Laurie/Install|Installation Log]]

== delete a page ==

Hi Laurie,

I'd like to delete

http://wiki.phpgedview.net/en/index.php?title=Download_v4.2.1

which advises using an old version which is no longer supported.

How do I find other pages that link to this one to fix those?

Thanks,

George
george at ringdevelopment.com

Installation Guide v4.2.x

2012-06-01T01:29:51Z

Ggpauly: /* Requirements */ updated PDO requirement

{{Phpgedview}}

This guide is for first-time installations. If you are upgrading an existing installation, see the article on [[Upgrading]].

The latest release on the v4.2.x series is version [[{{latest version|series=4.2.x}}]]. The release was made on {{latest version|series=4.2.x|release date=1}}.

We provide here a list of the [[#Requirements|requirements]] needed to install PhpGedView. We do not provide full details on how to install these since there are many dedicated websites providing such details and we would not do it justice in this guide. We assume you will have these [[#Requirements|requirements]] satisfied by your [[w:ISP|Internet Service Provider (ISP)]] or your chosen [[Web_hosting|web hosting]] solution. If you are unsure, contact them to check if they do.

==Quick Install==

* Contact your [[w:ISP|ISP]] or [[Web_hosting|web host]] to ensure they are able to supply the [[#Requirements|requirements]] to run PhpGedView.
* Download and unzip <tt>[http://downloads.sourceforge.net/phpgedview/PhpGedView-all-{{latest version|series=4.2.x}}.zip PhpGedView-all-{{latest version|series=4.2.x}}.zip]</tt> into a directory named <tt>phpgedview</tt> on your computer.
* Upload the <tt>phpgedview</tt> directory and all its contents to your web space using a method allowed by your ISP or [[Web_hosting|web host]].
* On the webserver, change the permissions of the following files and directories to be writable by the web server:
config.php
index/*
media/
media/thumbs/
* Point your browser to the directory where you uploaded your PhpGedView files (for example, http://www.yourserver.com/phpgedview/). You should now see a PhpGedView configuration screen. NOTE: make sure to have cookies enabled.
[[Image:Fig_3.jpg|centre|frame|Configuration Screen]]
* Enter the information required using the '?' help icons next to each label for guidance. You will need the MySQL database name, username and password provided by your ISP or web [[Web_hosting|web host]]. Click "Save".
* Enter the details of the PhpGedView administrator and click "Create User". 'NOTE: Password must be ≥ 6 characters.
[[Image:Fig_4.jpg|centre|frame|Create Admin User]]
* If you have not yet received any errors you will see a message like:
[[Image:Fig_5.jpg|centre|frame|Configuration Complete]]
* On the web server, change the permissions of the <tt>config.php</tt> file to be non-writable by the web server.
* You now have a clean PhpGedView installation ready for [[Add a GEDCOM|adding a GEDCOM]].

==Requirements==
Your [[w:ISP|ISP]] may provide you with the following services. If they do not, you will need to to find a suitable [[Web_hosting|web hosting]] solution.

; Web server
: A web server such as [http://httpd.apache.org/ apache] is required to serve the web pages over the internet.

; PHP v5.2+
: Your web server needs to be running [http://www.php.net PHP] version 5.2 or greater to generate dynamic HTML pages and use all of PhpGedView 4.2.x functions. A minimum 30 second script maximum execution is needed in your php.ini.

; PDO
PHP Data Objects (PDO) extension to PHP must be installed and enabled. This is a standard part of PHP, and allows PHP to connect to databases. PDO improves performance, improves sqlite compatibility, and allows a wider range of databases to be used.

; Database
: You will need at least 1 database and a username and password to access it.
: PhpGedView primarily supports MySQL, but has also been tested and shown to work with Postgresql, SQLite, and SQL-Server. The versions required for each of these databases is outlined below:
: MySQL 4.1+
: PostgreSQL 8.0+
: SQLite available through PDO-SQLite which is included in PHP 5
: MS SQL-Server 2003+

; Web space
: At least 20MB of web space on the web server. You will need more than this if you intend to store [[w:multimedia|multimedia]] linked to individuals.

; GD Graphics Library (optional)
: You may wish to install the [[w:GD Graphics Library|GD Graphics Library]] which can then be used by PhpGedView for image manipulation such as creating thumnails. This can be important in saving bandwidth if large images (photos and scanned documents) are used in the genealogy.

; Freetype Library (optional)
: If [[w:Freetype|Freetype]] is installed, you will have access to the "Circle Diagram" in the Charts menu. You will also get better watermarking from the [[Media Firewall]].

; Calendar (optional)
: This is required for Jewish dates/calendars wish to be used.

; zlib (optional)
: If the web server being used by your ISP or [[Web_hosting|web host]] is the apache web server, it can be configured to send data over the internet in a compressed form using the [[w:zlib|zlib library]] - this will save bandwidth. To enable this compression, your ISP or [[Web_hosting|web host]] needs to add the following lines to the <tt>php.ini</tt> file:
php_flag zlib.output_compression On
php_value zlib.output_compression_level 5

Alternatively, your ISP or [[Web_hosting|web host]] may allow you to make these changes yourself. Simply create a file called <tt>.htaccess</tt> (including the leading dot) in your PhpGedView directory on the web server and add the above two lines to it.

==Installation==
You must be familiar with methods to transfer files to another computer.

The method used may depend on the [[w:OS|OS]] and the settings of your web space provider as well as your own computer abilities. It is not possible to address every combination, thus we will address the most generic way to do so - the use of a graphical [[w:File Transfer Protocol|File Transfer Protocol (FTP)]] client. An example of a [[w:Free_software|free]], [[w:Open_source|open source]] [[w:FTP_client|FTP client]] is [[w:FileZilla|FileZilla]] - feel free to explore other [[w:Comparison_of_FTP_clients|alternative clients]].

We aim not detail how to use an FTP client as this is best addressed by the documentation of the client you choose to use. We will however, detail the tasks that need to be undertaken with the FTP client. Another alternative, if your web space provider allows it, is to use an [[w:SSH_clients|SSH client]]. However, we assume that if you know about SSH, you will likely already know what to do, so we will not discuss it here.

===Obtaining PhpGedView===
There are [[Download_v4.2.x|several packages available for PhpGedView v4.2.x]], and you should decide which is most appropriate for your needs.

Once you have downloaded the appropriate file to your own computer, you will need to [[w:ZIP (file format)|unzip]] the file into a directory of it's own e.g. <tt>phpgedview</tt>

===Uploading PhpGedView to Your Web Space===
Next, you should use your FTP client to transfer the <tt>phpgedview</tt> directory and all it's contents to your web space. The contents of this directory is quite large (~37MB) so this could take some time depending on your internet connection speed. However, you probably won't need all those files. With careful pruning, the upload can be reduced to around 9MB. You can also use your host's control panel, such as [[w:cPanel|cPanel]], to upload the compressed zip or tarball archive and then extract it once it is on the server.

The <tt>phpgedview</tt> directory in your web space, will now be referred to as the "PhpGedView install directory".

===Setting File Permissions===
{{main|Setting File Permissions}}
In order for PhpGedView to function correctly, the web server hosting your PhpGedView installation needs to have the permission to save and modify files in a limited number of directories within your PhpGedView install directory. Your FTP client should be capable of allowing you to modify these permissions (called attributes in some clients). Briefly, you should make the following directories and files in your PhpGedView install directory writable by everyone:

index/* # comment: '*' means all files and folders in that directory
media/
media/thumbs/

Essentially, this will allow PhpGedView to save multimedia files on the server.

====More Secure Permissions====
If your web server is hosted on a [[w:Unix-like|Unix-like]] OS and you know enough about what permissions are and how to set them, you should set permissions rigidly for a more secure installation.
# Determine what "user group" the web server runs process as. e.g. Apache2 on Debian runs as "www-data" by default.
# Change the "ownership" of all directories and files under the PhpGedView install directory to be owned by you.
# Change the "group membership" of all directories and files under the PhpGedView install directory to be that of the web server.
# Ensure all directories and files under the PhpGedView install directory '''cannot''' be written by the group members.
# Set specified directories and files to be group writable.

If you have SSH access to your [[w:Unix-like|Unix-like]] web server, the following commands should take care of this. It assumes the web server is running with group membership of "www-data", and your username is YOUR_USERNAME):
chown -R YOUR_USERNAME ./phpgedview/
chgrp -R www-data ./phpgedview/
chmod -R g-w ./phpgedview/
chmod g+w ./phpgedview/index/
chmod g+w ./phpgedview/media/
chmod g+w ./phpgedview/media/thumbs/

===Online PhpGedView Configuration===
There exists a tool in PhpGedView that allows you to make changes to the PhpGedView configuration, this needs to be performed to complete the installation.

In order to do this, the web server must have permissions to write to the <tt>config.php</tt> file in the PhpGedView install directory to be able to save the changes.

WARNING: you should set <tt>config.php</tt> permissions back to not writable by the web server immediately after performing the configuration! Failing to do so will leave your PhpGedView installation at risk!

'''NOTE: you need cookies enabled to run the install script.''' This is not checked for. Without cookies enabled the install script fails in ways that point to other issues like not having the config.php file write-able or not having proper access to the database.

* Using the FTP client, set the permissions of <tt>config.php</tt> in the PhpGedView install directory to be writable by everyone. Alternatively, if you are using an SSH client you could issue the following command:
chmod g+w ./phpgedview/config.php

* Point your web browser to the PhpGedView install directory (for example, http://www.yourserver.com/phpgedview/). You should now see a PhpGedView configuration screen.
[[Image:Fig_3.jpg|centre|frame|Configuration Screen]]

* Enter all relevant information into the form, clicking the help ('?') icons for guidance. You will need the MySQL database name, username and password provided by your ISP or [[Web_hosting|web host]]. Click "Save".

* Extra Configuration tips for those with ISPs who do not host PHPGedview ( this advice relates to an ISP which uses the online control panel program called "cpanel" and the phpmyadmin and mysqldatabases utilities);
host name is "localhost",
database name is "accountname_name of database",
use mysqldatabases utility to create a database and then a user that can access the database. Again usernames may have been automatically prefixed with the ISP account name - use the mysqldatabases utility to see.

* Enter the details of the PhpGedView administrator and click "Create User". 'NOTE: Password must be ≥ 6 characters.
[[Image:Fig_4.jpg|centre|frame|Create Admin User]]

* If you have not yet received any errors you will see a message like:
[[Image:Fig_5.jpg|centre|frame|Configuration Complete]]

* Using your FTP client, change the permissions of the <tt>config.php</tt> file to be non-writable. If you are using an SSH client, make the <tt>config.php</tt> file non-writable by the group:
chmod g-w ./phpgedview/config.php

* You now have a clean PhpGedView installation ready for [[Add_a_GEDCOM|adding a GEDCOM]].

==Upgrading From a Previous Version==

Go to this page for [[Upgrading]]. It is usually a reasonably straightforward process, but can vary widely depending on your [[w:OS|OS]], your [[w:ISP|ISP]] etc.

=Post-Install Tasks and Configuration=

==License==
{{License}}

[[Category:PhpGedView]]
[[Category:Installation Guide]]

Installation Guide

2012-06-01T01:21:57Z

Ggpauly: updated to reflect current version support policy

#REDIRECT [[Installation_Guide_v{{latest stable series}}]]

It should be noted that the current release version of phpGedView (PGV) requires you have authorized access to a database (usually MySQL or SQLite, but PGV does work with other DB's) '''AND''' that this database contains PDO drivers. All system requirements and cautions for most installations, as well as a step-by-step procedures, are explained in the detailed setup accessed from the above Installation Guide link.

To see if your database has PDO available, access your PHP info page and review the PDO drivers status. If PDO support is not enabled, you must either ask that the PDO drivers be installed and enabled, or switch ISPs to one that provides these drivers to use the current release version of PhpGedView.

Download v4.2.x

2012-06-01T01:09:01Z

Ggpauly: changed to reflect current version support

While the latest stable release is v[[{{latest version|series=4.2.x}}]], it was released on {{latest version|series=4.2.x|release date=1}}. The current SVN release is a slightly improved version titled v4.3 and is the recommended stable replacement for v4.2.4. See PGV's [https://sourceforge.net/projects/phpgedview/forums/forum/185166/topic/4392768 Sourceforge help forum] for download details.

[[image:gedview.gif|right]]
All older versions are no longer supported and should be upgraded.

==Download Packages==
For convenience PhpGedView {{latest version|series=4.2.x}} has been divided into several packages which allows you to choose what you want to download.

[[Modules]] are plug-ins to PhpGedView which provide additional features or functionality not found in the core files. Some modules may require additional software. See the installation instructions for each module for their requirements.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PhpGedView-basic-{{latest version|series=4.2.x}}.zip PhpGedView (BASIC) {{latest version|series=4.2.x}}]
: This package contains the core files to run PhpGedView. It includes the most commonly requested themes and language files. It does not include place maps or any modules.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PhpGedView-all-{{latest version|series=4.2.x}}.zip PhpGedView (ALL) {{latest version|series=4.2.x}}]
: This package contains the complete set files to run PhpGedView, including all themes and language files, place maps and modules. After installation you can disable the modules you don't need.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Demo-{{latest version|series=4.2.x}}.zip Windows Demo ]
: This package is a self contained demo version of PhpGedView which can be run out of the box on Windows based systems. This package is great if you want to take PGV for a test drive or if you want to burn your own data for distribution on a CD.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Themes-{{latest version|series=4.2.x}}.zip Themes ]
: This package includes other themes maintained with PhpGedView. Other user submitted themes can be found at http://www.pgvthemes.com/

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Places-{{latest version|series=4.2.x}}.zip Places ]
: This package includes place maps for many different countries. Place maps can be enabled in the place hierarchy and on the editing pages.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Languages-{{latest version|series=4.2.x}}.zip Languages ]
: This package includes the other languages that have been submitted to PGV including Arabic, Catalan, Czech, Danish, Greek, Spanish, Estonian, Finnish, Hebrew, Hungarian, Indonesian, Italian, Lithuanian, Dutch, Polish, Portuguese, Romanian, Russian, Serbian, Slovakian, Slovenian, Turkish, Vietnamese, and Chinese.

==Download Modules==
To install a module just upload it to the "modules" directory in your PhpGedView folder. All of these modules are included in the "PhpGedView (ALL) {{latest version|series=4.2.x}}" package above.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-googlemap-{{latest version|series=4.2.x}}.zip GoogleMap Module ] : This module enables GoogleMap support in the program. It will put a person's events on a map from Google.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-research_assistant-{{latest version|series=4.2.x}}.zip Research Assistant Module ] : This module enables the a research assistant tool in PGV. This tool is designed to help you with your genealogical research. It provides a way to manage and track research tasks as well as the ability to quickly enter data from sources such as census forms.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-Module-lightbox-{{latest version|series=4.2.x}}.zip Lightbox Module ] : This module enables an alternate way to experience media in PhpGedView. It provides an "Album" tab on the individual page, media slideshows, and other media enhancements.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-gallery2-{{latest version|series=4.2.x}}.zip Gallery Module ] : This module enables support and integration with the Gallery project.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-punbb-{{latest version|series=4.2.x}}.zip PunBB Module ] : This module enables support and integration with the PunBB forum project. It will allow you to include message forums in your PGV site.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-phpsysinfo-{{latest version|series=4.2.x}}.zip PhpSysInfo Module ] : This module enables support and integration with the PhpSysInfo project.

;[https://sourceforge.net/project/downloading.php?group_id=55456&filename=PGV-Module-sitemap-{{latest version|series=4.2.x}}.zip Sitemap Module ] : This module enables a site map useful for crawlers and search engines.

==Source Repositories==
You can also obtain the files from one of the following source repositories

===Subversion v4.2+===
You can also get the latest bug fixes from the main trunk of the subversion repository. Code in the [[SVN]] repository can be considered Release Candidate quality.

If you would like to try out the latest features or help to beta test new versions, then you can get the latest development code from the 4.2 branch of the Subversion repository. Code in any branches of the repository should be considered alpha/beta quality and is not recommended for production environments.

The following SVN command will get you the latest code:

export LC_ALL=en_US
svn co https://phpgedview.svn.sourceforge.net/svnroot/phpgedview/trunk/phpGedView phpgedview

You can find out more information and browse the SVN repostory online at this location https://sourceforge.net/svn/?group_id=55456

[[Category:PhpGedView]]

Web hosting

2011-12-02T20:37:43Z

Ggpauly: removed dead link

A '''web host''' provides the hardware, software and support to clients who wish to publish content on the internet. Many web hosts will meet the [[Installation_Guide#Requirements|minimum requirements]] to run [[PhpGedView]], with some specifically advertising that they support PhpGedView. For some, the installation of PhpGedView may be beyond the ability of users who wish to install and use their own PhpGedView powered website. Therefore, some web hosts have included automatic (or "one-click") install scripts, making it very simple to install and setup.

When selecting a hosting solution ensure that they meet all of the [[Installation_Guide#Requirements|installation requirements]].

==Hosts that support PhpGedView==
* [http://www.dreamhost.com/ Dreamhost] - has a one-click install and a control panel for easy upgrades, '''but''' after [[upgrading]] you can get PHP errors and SQL errors, so DreamHost's upgrading doesn't seem to work right yet.
* [http://www.dotservant.com/ Dotservant.com website hosting]
* [http://www.familywebhost.com FamilyWeb]
* [http://www.relatedfamilies.com/ RelatedFamilies] Automatic installation, Automatic upgrades, 15-Day Free Trial. No setup fee.
** RelatedFamilies specializes in hosting Genealogy and Family web sites. PhpGedView will be automatically installed for you in a matter of seconds at sign-up time. Future upgrades will also be automatic.
* [http://www.yourbeginnings.com/web/ Your Beginnings] Ad supported.
** YourBeginnings (YB) offers free website hosting for your family history using phpGEDView (PGV). PGV makes getting your family history on the Internet simple. YB installs the software on our server, configures the software and uploads your GEDCOM file for you. All you have to do is invite your users and document your family story. Ad supported.(24 Mar 2009) 
* [http://ancestortree.net Ancestor Tree] free trial, security options, automatic upgrades, backups, no setup fee, no ads
** Choose Ancestor Tree for the most complete full service Family Tree hosting available. We take care of all the website chores (installation, security configuration, upgrades, and backups) We emphasize friendly and competent customer service. Frequent backups - four times a day. Choose from four plans offering increasing security and access options. No ads! Your family website is safe with our secure, reliable, and high quality service. Try our PawPaw plan for free for 15 days. 

== External Links ==

* [[w:Web_hosting_service|Wikipedia]]

[[Category:PhpGedView]]

Contact

2011-01-16T01:46:21Z

Ggpauly: update forum urls

The following is intended to help orientate you to the possible avenues of contact depending on what you may have come here for.

=What is PhpGedView?=
For details about what PhpGedView is and does, please refer to the [[PGVWiki:About|About]] page.

=Users Seeking Help=
If you require help using PhPGedView, you should first take a look at the following PGVWiki pages or [[Special:Search|search the PGVWiki]] for appropriate articles:

* [[Users Guide]] - A guide on how to use PhpGedView
* [[How To]] guides - Detailed, step-by-step guides on how to address specific tasks relating to PhpGedView
* [[FAQ]] - Lists of frequently asked question with answers

If you do not find the answers to your question(s), feel free to contact us on one of our SourceForge [https://sourceforge.net/projects/phpgedview/forums hosted forums]:

* [https://sourceforge.net/projects/phpgedview/forums/forum/185166 Help] Forum - Request help from other users for phpGedView
* [https://sourceforge.net/projects/phpgedview/forums/forum/185165 Open Discussion] Forum - Discuss anything related to phpGedView
* [https://sourceforge.net/projects/phpgedview/forums/forum/294245 Translations] Forum - This forum is for the translation of phpGedView into different languages

We also have had SourceForge hosted mailing lists (the last being for making [http://sourceforge.net/mailarchive/forum.php?forum_name=phpgedview-announce PhpGedView announcements]). These are no longer active.

=PGVWiki Website=
If you require assistance with a technical problem with any of the PGVWiki sites then contact [http://wiki.phpgedview.net/en/index.php?title=User_talk:Laurie&action=edit&section=new Laurie and leave me a message].

PGVWiki talk:Bulletin Board

2011-01-16T00:58:07Z

Ggpauly: removal suggestion

Should this page be removed? It's a duplication of the forums.

Upgrading

2011-01-16T00:52:01Z

Ggpauly: updated version link

This article deals with upgrading an existing installation of [[PhpGedView]].

==Before you start==

# Check the version of your current PhpGedView installation. It is displayed on the site admin page.
#* If your current version is 3 (or earlier), read the [[Upgrading from 3.x to 4.x]] article first. Direct Upgrades from version 3 to the latest version have not been tested, although they may work. It might be safer to upgrade to 4.0.2 as an intermediate step.
#* If your current version is 4 (or later), follow the instructions on this page.
# Check the version of PHP on your webserver. You can find this out by following the 'PHP Information' link on the site admin page.
#* If you have PHP5.2 or later, you can run the latest version of PhpGedView.
#* If you have an older version of PHP, you should install [https://sourceforge.net/projects/phpgedview/files/1%20PhpGedView/PhpGedView%20v4.1.7/ PhpGedView 4.1.7]. This was the last version to run on PHP4.
#* Note that many ISPs offer ''both'' PHP4 and PHP5. You often need to edit a configuration file or use a control panel to switch between them.
# Check whether the PDO database driver is available on your server. From the "PHP Information" link on your admin page, look for a section called PDO. You should see "PDO Enabled", and a driver for the database you intend to use. Check with your web host if you are unsure.
#* If PDO is not available, then you should install [https://sourceforge.net/projects/phpgedview/files/1%20PhpGedView/PhpGedView%20v4.2.1/ PhpGedView 4.2.1].
#* If PDO is available, you can run the latest version of PhpGedView, currently [https://sourceforge.net/projects/phpgedview/files/1%20PhpGedView/PhpGedView%20v4.2.4/ PhpGedView 4.2.4].
# While reviewing the PHP Information, also check your available memory allocation. PhpGedView requires at a minimum of 32mb of allocatable RAM for small GEDCOMs and is happy to consume much more, depending upon the size of your GEDCOM. 64mb of allocatable memory is a recommended base level.
# If your site allows other users to make online edits, you should ''temporarily'' disable them in the gedcom configuration page. (To do this in 4.1.x, use the "Admin" link at top of page -> "Manage GEDCOMs and edit Privacy" -> click "edit" on the "Configuration file" line -> "Edit Options" -> "Enable online editing" -> set to "No").
# Accept or reject any pending GEDCOM edits. (There is a link for doing this in the page header/footer.)
# Make sure that gedcom files in your index directory are up-to-date. If you have enabled "sync changes to gedcom file" in your gedcom configuration, then they ''should'' be up-to-date. (To check this in 4.1.x, go: "Admin" link at top of page -> "Manage GEDCOMs and edit Privacy" -> click "edit" on the "Configuration file" line -> "Edit Options" -> "Synchronize edits into GEDCOM file" -> check this field is set to "Yes".) However discrepancies can creep in over time, and it is recommended to update it anyway.
#* In PhpGedView version 4.1 and earlier, you should use the download-gedcom option, and then copy the file back to the server. (To do this, use "Admin" link at top of page -> Manage GEDCOMs and edit Privacy -> click "download" on the "GEDCOM file" line -> select "GEDCOM" under "Choose File Type", untick "Remove custom PGV tags? (eg. _PGVU, _THUM)", tick "Zip File(s)" -> click "download now".)
#* In PhpGedView version 4.2 and later, you can use the export option from the manage gedcoms page to achieve the same thing more quickly.
# If you are using custom themes, check with the theme author to find out whether it is compatible with the version of PhpGedView you are installing. If it is not, or you don't know, use the user administration page to change all users to one of the standard themes.
# If you have customised any of the PHP scripts to change the behaviour of PhpGedView, you should make preparations to implement the same customisations on your new installation.
# Make a backup copy of your database. This step is optional, and should only be required if, during your upgrade process, something goes wrong. There are several ways to do this, depending on your server configuration:
#* sqlite
#** simply make a copy of the database file.
#* MySQL
#** If you run your own server, make a copy of the raw database files.
#** If you have access to the phpMyAdmin tool, it offers an SQL export facility.
#* General
#** An export utility is available from the [https://sourceforge.net/tracker/index.php?func=detail&aid=2318005&group_id=55456&atid=477081 patches tracker] which can export/import your database tables to files in your index directory.
# Make a backup copy of the configuration files and data directories on your server.
#* Your configuration file: /config.php
#* Your media directory and its contents: /media
#* Your index directory and its contents: /index
#* Any local translations: /languages/extra.XX.php
#* The configuration files of any modules that you use: /modules/XXXXX/config.php
# Make another backup. Upgrade problems can always be repaired - but only if you have a backup!
# click the "Logout" link at the top of the page.

==Obtaining the latest distribution==

Download the appropriate .zip file from [https://sourceforge.net/project/showfiles.php?group_id=55456&package_id=61562 sourceforge.net] and extract the contents of it to your desktop computer.

There are two current versions available:
* the full version (e.g. PhpGedView-all-X.Y.Z.zip) which contains ''all'' the languages, ''all'' the themes and ''all'' the optional modules.
* the basic version (e.g. PhpGedView-basic.X.Y.Z.zip) which contains just the ''major'' languages, the ''most popular'' themes and ''no'' optional modules.

If you downloaded the full version, you should delete any modules/languages/themes that you don't use.
If you downloaded the basic version, you may also download any of the optional modules/languages/themes that you want.

* Languages are stored in the /languages/ directory. Add/remove complete sets of language files, such as *.XX.php.
* Modules are stored in the /modules/ directory. Add/remove sub-directories, together with the corresponding .php file of the same name.
* Themes are stored in the /themes/ directory. Add/remove complete sub-directories.

You may choose a different combination of modules/languages/themes to the one in your current installation. Should you need an earlier version of phpGedView. most previous stable releases are listed below these current versions.

It is generally simpler to download the full version and delete rather than download the basic version and add to it. However, if you have slow/limited internet connectivity, you may want to start with the basic version and add to it.

==Preparing the distribution files==

The following files and directories will be included with the distribution. These are only needed when setting up a new installation and contain default values. Since we are upgrading an existing installation, we want to keep the existing files on the server. Delete the following files and directories from your temporary area before you upload them.

* The file /config.php
* The directory /index/ and all its contents
* The directory /media/ and all its contents

==Clean up the current files on the server==

Delete all the files/directories on your server '''except''' the following:

* The application configuration file: /config.php
* Any local function customisation file: /includes/functions.extra.php
* The application data directory: /index/
* Any local language file customisations: /languages/extra.XX.php
* Any local language event history customisations: /languages/histo.XX.php
* The multi-media storage directory: /media/
* Any 3rd party module specific files: /modules/XXX.php
* Any module configuration files: /modules/XXX/config.php

This is the reverse of the files you deleted in the previous step.

Delete the following directory on your server, and all its contents. PhpGedView will recreate it when it needs it.

* /index/cache/

Delete the following file on your server. PhpGedView will recreate it when it needs it.

* /index/reports.dat

==Copy the new distribution files to the server==
Copy all the distribution files you prepared in the previous step to your server. This will replace the ones you just deleted.

==Re-import Gedcom Data==

If you have performed a major upgrade (e.g. 4.1.x to 4.2.x) you will be required to reimport your gedcom files. If you have performed a minor upgrade (e.g. 4.2.x to 4.2.y) this step is optional.

Log in to the server as a site administrator. Go to the manage gedcom page, if you are not automatically redirected there.

Import each gedcom in turn by selecting the "import" option and following the instructions. If these gedcoms were created by PGV and contain media files, upon reimport, select "NO" to the question of 'keep media links'. '''Failure to do so will cause duplicate media links and media to appear to be unlinked''' to your individuals, families and sources.

==Sanity Check==

Briefly check the major functions areas;
* individual and family details
* charts
* reports
* multimedia
* modules such as googlemaps or research-assistant

Upgrade problems tend to result in complete success or complete failure. If there are no obvious errors, you should be fine.

==Post Installation Steps==

* Re-enable online editing, if you disabled it earlier

Advanced HTML block

2010-08-24T19:25:02Z

Ggpauly:

The '''Advanced HTML block''' is an [[HTML block]] that you can place on your page to add any sort of message you may want. You can insert references to information from your GEDCOM into the HTML text.

==Example==

For example, this HTML
<pre>
This site was last updated on #gedcomUpdated#. There are #totalSurnames# surnames in this family tree. The
earliest recorded event is the #firstEventType# of #firstEventName# in #firstEventYear#. The most recent
event is the #lastEventType# of #lastEventName# in #lastEventYear#. 

 

If you have any comments or feedback please contact #contactWebmaster#.

</pre>

Results in this output:
<pre>
This site was last updated on 15 March 2010. There are 2 surnames in this family tree. The earliest recorded
event is the birth of Father's Name Surname (I2) in 1830. The most recent event is the birth of Given Names
Surname (I1) in 1850.

If you have any comments or feedback please contact Admin admin.
</pre>

==Built-in Variables==

List of the variables built into the Advanced HTML block, together with the resulting text when a reference to this variable is embedded in the HTML code supplied to the Advanced HTML block. (trunk version Aug. 2010)
<pre>
Variable Resultant text
gedcomFilename ourfamily.ged
gedcomID 1
gedcomTitle Our Family
gedcomCreatedSoftware PhpGedView
gedcomCreatedVersion 4.2.3
gedcomDate 15 March 2010
gedcomUpdated 15 March 2010
gedcomHighlight
gedcomHighlightLeft
gedcomHighlightRight
totalRecords 7
totalIndividuals 3
totalIndisWithSources 0
chartIndisWithSources With sources [0%], Without sources [100%]
totalIndividualsPercentage 42.86%
totalFamilies 1
totalFamsWithSources 0
chartFamsWithSources With sources [0%], Without sources [100%]
totalFamiliesPercentage 14.29%
totalSources 0
totalSourcesPercentage 0%
totalNotes 0
totalNotesPercentage 0%
totalOtherRecords 3
totalOtherPercentage 42.86%
totalSurnames 1
totalGivennames 3
totalEvents 3
totalEventsBirth 3
totalBirths 3
totalEventsDeath 0
totalDeaths 0
totalEventsMarriage 0
totalMarriages 0
totalEventsDivorce 0
totalDivorces 0
totalEventsOther 0
totalSexMales 1
totalSexMalesPercentage 33.33%
totalSexFemales 1
totalSexFemalesPercentage 33.33%
totalSexUnknown 1
totalSexUnknownPercentage 33.33%
chartSex Males [33.3%], Females [33.3%], Unknown [33.3%]
totalLiving 0
totalLivingPercentage 0%
totalDeceased 3
totalDeceasedPercentage 100%
totalMortalityUnknown 0
totalMortalityUnknownPercentage 0%
mortalityUnknown
chartMortality Living [0%], Dead [100%]
totalUsers 1
totalAdmins 1
totalNonAdmins 0
totalMedia 0
totalMediaAudio 0
totalMediaBook 0
totalMediaCard 0
totalMediaCertificate 0
totalMediaCoatOfArms 0
totalMediaDocument 0
totalMediaElectronic 0
totalMediaMagazine 0
totalMediaManuscript 0
totalMediaMap 0
totalMediaFiche 0
totalMediaFilm 0
totalMediaNewspaper 0
totalMediaPainting 0
totalMediaPhoto 0
totalMediaTombstone 0
totalMediaVideo 0
totalMediaOther 0
totalMediaUnknown 0
chartMedia None
totalPlaces 1
chartDistribution
Individual distribution chart

Individual distribution chart
Highest population Lowest population Nobody at all
commonCountriesList

* Click edit and change me ‎[1]‎

commonBirthPlacesList

* Click edit and change me ‎[1]‎

commonDeathPlacesList

commonMarriagePlacesList

statsBirth Births by century
statsDeath
firstBirth Father's Name Surname ‎(I2)‎
Birth 1830
firstBirthYear 1830
firstBirthName Father's Name Surname (I2)
firstBirthPlace
lastBirth Given Names Surname ‎(I1)‎
Birth 1 January 1850 20 20 -- Click edit and change me
lastBirthYear 1850
lastBirthName Given Names Surname (I1)
lastBirthPlace Click edit and change me
firstDeath
firstDeathYear
firstDeathName
firstDeathPlace
lastDeath
lastDeathYear
lastDeathName
lastDeathPlace
statsAge
longestLife
longestLifeAge
longestLifeName
topTenOldest
topTenOldestList
topTenOldestAlive
topTenOldestListAlive

averageLifespan 0
longestLifeFemale
longestLifeFemaleAge
longestLifeFemaleName
topTenOldestFemale
topTenOldestFemaleList
topTenOldestFemaleAlive
topTenOldestFemaleListAlive

averageLifespanFemale 0
longestLifeMale
longestLifeMaleAge
longestLifeMaleName
topTenOldestMale
topTenOldestMaleList
topTenOldestMaleAlive
topTenOldestMaleListAlive

averageLifespanMale 0
firstEvent Father's Name Surname ‎(I2)‎
Birth 1830
firstEventYear 1830
firstEventType birth
firstEventName Father's Name Surname (I2)
firstEventPlace
lastEvent Given Names Surname ‎(I1)‎
Birth 1 January 1850 20 20 -- Click edit and change me
lastEventYear 1850
lastEventType birth
lastEventName Given Names Surname (I1)
lastEventPlace Click edit and change me
statsMarr
statsDiv
firstMarriage
firstMarriageYear
firstMarriageName
firstMarriagePlace
lastMarriage
lastMarriageYear
lastMarriageName
lastMarriagePlace
firstDivorce
firstDivorceYear
firstDivorceName
firstDivorcePlace
lastDivorce
lastDivorceYear
lastDivorceName
lastDivorcePlace
statsMarrAge
youngestMarriageFemale
youngestMarriageFemaleName
youngestMarriageFemaleAge
oldestMarriageFemale
oldestMarriageFemaleName
oldestMarriageFemaleAge
youngestMarriageMale
youngestMarriageMaleName
youngestMarriageMaleAge
oldestMarriageMale
oldestMarriageMaleName
oldestMarriageMaleAge
ageBetweenSpousesMF Father's Name Surname + Mother's Name Surname ‎[30 months]‎
ageBetweenSpousesMFList

* Father's Name Surname + Mother's Name Surname ‎[30 months]‎

ageBetweenSpousesFM Father's Name Surname + Mother's Name Surname ‎[30 months]‎
ageBetweenSpousesFMList

* Father's Name Surname + Mother's Name Surname ‎[30 months]‎

topAgeOfMarriageFamily
topAgeOfMarriage
topAgeOfMarriageFamilies
topAgeOfMarriageFamiliesList

minAgeOfMarriageFamily
minAgeOfMarriage
minAgeOfMarriageFamilies
minAgeOfMarriageFamiliesList

youngestMother Mother's Name Surname ‎(I3)‎
Birth 1830
youngestMotherName Mother's Name Surname
youngestMotherAge 20
oldestMother Mother's Name Surname ‎(I3)‎
Birth 1830
oldestMotherName Mother's Name Surname
oldestMotherAge 20
youngestFather Father's Name Surname ‎(I2)‎
Birth 1830
youngestFatherName Father's Name Surname
youngestFatherAge 20
oldestFather Father's Name Surname ‎(I2)‎
Birth 1830
oldestFatherName Father's Name Surname
oldestFatherAge 20
totalMarriedMales 0
totalMarriedFemales 0
largestFamily Father's Name Surname + Mother's Name Surname ‎(F1)‎
largestFamilySize 1
largestFamilyName Father's Name Surname + Mother's Name Surname
topTenLargestFamily Father's Name Surname + Mother's Name Surname ‎[1 children]‎
topTenLargestFamilyList

* Father's Name Surname + Mother's Name Surname ‎[1 children]‎

chartLargestFamilies Largest families
totalChildren 1
averageChildren 1.00
statsChildren
topAgeBetweenSiblingsName
topAgeBetweenSiblings
topAgeBetweenSiblingsFullName
topAgeBetweenSiblingsList
noChildrenFamilies 0
noChildrenFamiliesList
chartNoChildrenFamilies
topTenLargestGrandFamily
topTenLargestGrandFamilyList
getCommonSurname SURNAME
commonSurnames Surname
commonSurnamesTotals Surname ‎[3]‎
commonSurnamesList

* Surname

commonSurnamesListTotals

* Surname ‎[3]‎

chartCommonSurnames Surname - 3, Other - 0
commonGiven Name; Mother's; Father's
commonGivenTotals Name ‎[2]‎; Mother's ‎[1]‎; Father's ‎[1]‎
commonGivenList

* Name
* Mother's
* Father's

commonGivenListTotals

* Name ‎[2]‎
* Mother's ‎[1]‎
* Father's ‎[1]‎

commonGivenTable
ALL
Names Count
Name 2
Mother's 1
Father's 1
commonGivenFemale Name; Mother's
commonGivenFemaleTotals Name ‎[1]‎; Mother's ‎[1]‎
commonGivenFemaleList

* Name
* Mother's

commonGivenFemaleListTotals

* Name ‎[1]‎
* Mother's ‎[1]‎

commonGivenFemaleTable
Female
Names Count
Name 1
Mother's 1
commonGivenMale Name; Father's
commonGivenMaleTotals Name ‎[1]‎; Father's ‎[1]‎
commonGivenMaleList

* Name
* Father's

commonGivenMaleListTotals

* Name ‎[1]‎
* Father's ‎[1]‎

commonGivenMaleTable
Male
Names Count
Name 1
Father's 1
commonGivenUnknown Names; Given
commonGivenUnknownTotals Names ‎[1]‎; Given ‎[1]‎
commonGivenUnknownList

* Names
* Given

commonGivenUnknownListTotals

* Names ‎[1]‎
* Given ‎[1]‎

commonGivenUnknownTable
unknown
Names Count
Names 1
Given 1
chartCommonGiven Name - 2, Mother's - 1, Father's - 1, Other - -1
usersLoggedIn 1 logged-in user: Admin admin - Site
usersLoggedInList 1 logged-in user

* Admin admin - Site

usersLoggedInTotal 1
usersLoggedInTotalAnon 0
usersLoggedInTotalVisible 1
userID 1
userName Site
userFullName Admin admin
userFirstName Admin
userLastName admin
latestUserId 1
latestUserName Site
latestUserFullName Admin admin
latestUserFirstName Admin
latestUserLastName admin
latestUserRegDate Sat Aug 2010
latestUserRegTime 2:42:04pm
latestUserLoggedin Yes
contactWebmaster Admin admin
contactGedcom Admin admin
serverDate 24 August 2010
serverTime 2:59 pm
serverTime24 14:59
serverTimezone EDT
browserDate 24 August 2010
browserTime 2:59 pm
browserTime24 14:59
browserTimezone EDT

</pre>

==Developer Info==

; SVN Trunk Link
: http://phpgedview.svn.sourceforge.net/viewvc/phpgedview/trunk/phpGedView/blocks/block_htmlplus.php?view=markup

[[Category:PhpGedView|Advanced HTML block]]
[[Category:Blocks|Advanced HTML block]]

Web hosting

2010-08-16T00:10:02Z

Ggpauly: update entry, remove dead link

A '''web host''' provides the hardware, software and support to clients who wish to publish content on the internet. Many web hosts will meet the [[Installation_Guide#Requirements|minimum requirements]] to run [[PhpGedView]], with some specifically advertising that they support PhpGedView. For some, the installation of PhpGedView may be beyond the ability of users who wish to install and use their own PhpGedView powered website. Therefore, some web hosts have included automatic (or "one-click") install scripts, making it very simple to install and setup.

When selecting a hosting solution ensure that they meet all of the [[Installation_Guide#Requirements|installation requirements]].

==Hosts that support PhpGedView==
* [http://www.dreamhost.com/ Dreamhost] - has a one-click install and a control panel for easy upgrades, '''but''' after [[upgrading]] you can get PHP errors and SQL errors, so DreamHost's upgrading doesn't seem to work right yet.
* [http://www.dotservant.com/ Dotservant.com website hosting]
* [http://www.familywebhost.com FamilyWeb]
* [http://www.relatedfamilies.com/ RelatedFamilies] Automatic installation, Automatic upgrades, 15-Day Free Trial. No setup fee.
** RelatedFamilies specializes in hosting Genealogy and Family web sites. PhpGedView will be automatically installed for you in a matter of seconds at sign-up time. Future upgrades will also be automatic.
* [http://www.yourbeginnings.com/web/ Your Beginnings] Ad supported.
** YourBeginnings (YB) offers free website hosting for your family history using phpGEDView (PGV). PGV makes getting your family history on the Internet simple. YB installs the software on our server, configures the software and uploads your GEDCOM file for you. All you have to do is invite your users and document your family story. Ad supported.(24 Mar 2009) 
* [http://www.ourroots.info/ ourroots.info]
* [http://ancestortree.net Ancestor Tree] free trial, security options, automatic upgrades, backups, no setup fee, no ads
** Choose Ancestor Tree for the most complete full service Family Tree hosting available. We take care of all the website chores (installation, security configuration, upgrades, and backups) We emphasize friendly and competent customer service. Frequent backups - four times a day. Choose from four plans offering increasing security and access options. No ads! Your family website is safe with our secure, reliable, and high quality service. Try our PawPaw plan for free for 15 days. 

== External Links ==

* [[w:Web_hosting_service|Wikipedia]]

[[Category:PhpGedView]]

Additional Security Procedures

2010-07-28T13:27:50Z

Ggpauly: /* Procedures */

==Introduction==

After [[Installation_Guide_v4.2.x|installing]] and [[Setting_File_Permissions|securing]] your website, you can take these additional steps to further secure it.

==Procedures==

These procedures are independent of each other and not in procedural order.

<li>Move the index directory out of your document root directory (eg html_public) and set $INDEX_DIRECTORY in the config.php file accordingly.

<li>Create a tmp_session sub-directory in your index directory, and set this as your session save path.

<li>Move the config.php file out of your document root directory, replacing it with a file that requires it at the new location. For example, require_once "../safefolder/config.php";

<li>Use [[Media_Firewall|Media Firewall]] to protect media files from unauthorized access.

Configuration - Multimedia

2010-07-27T23:47:36Z

Ggpauly: /* Multimedia Directory */

''Part of:'' [[Configuration File|GEDCOM Configuration]]

===Enable Multimedia Features===

GEDCOM 5.5.1 allows you to link pictures, videos, and other multimedia objects into your GEDCOM. These links will be shown in the GEDCOM file using the OBJE tag (Example shown below which points to Media item No 6).

1 OBJE @M6@

The link will point to the media items reference number which will be contained in the GEDCOM file in the format shown below. (Please note in this case the media depth is set to 0.)

<pre>
0 @M6@ OBJE
1 FILE media/Example.jpg
2 FORM jpg
3 TYPE photo
2 TITL Example Photo
1 _PRIM Y
1 _THUM N
1 CHAN
2 DATE 04 FEB 2006
</pre>

If you do not include multimedia objects in your GEDCOM, you can disable the multimedia features by setting this value to No.

==General==
===Keep Links===

When a multimedia link is found starting with for example http://, ftp://, mms:// it will not be altered when set to Yes. For example, http://www.myfamily.com/photo/dad.jpg will stay http://www.myfamily.com/photo/dad.jpg. When set to No, the link will be handled as a standard reference and the media depth will be used. For example: http://www.myfamily.com/photo/dad.jpg will be changed to ./media/dad.jpg

===Multimedia Directory===

The path indicated in this setting must be set as a '''readable''' and '''writable''' directory. This is where PhpGedView will store media files (ensure you include the trailing "/" in this setting). PhpGedView does not require this directory's name to be "media". You can choose any name you like. When entering this directory its location is relative to your phpGedView directory. That is, in the example shown it will be a directory "media" contained in the phpGedView directory. It is recommended, however, to use the default setting '''media/''' unless you have some specific reasons to move it somewhere else.

'''Important:''' The directory must be accessible to the webserver so must exist within a directory the webserver can access.

The table below gives examples of legal and illegal locations of the media directory, assuming that your PhpGedView installation is in '''/home/www/phpgedview''' directory. The examples include relative and absolute paths of files to assist in configuration. The relative path is what you type in the Multimedia Directory field.

{| border=1 align=center
|+Legal Media Paths
!width=35%|Absolute path
!width=25%|Relative path
!width=30%|Comments
!width=10%|Legal
|----bgcolor=#FFFF99 align=left
|/home/www/phpgedview/media
|media/
|default
|Yes
|---- bgcolor=#FFFF99 align=left
|/home/www/phpgedview/pictures/media/
|pictures/media/
|
|Yes
|---- bgcolor=#FFFF99 align=left
|/home/www/media
|../media/
|
|Yes
|---- bgcolor=#FFFF99 align=left
|/home/media
|../../media/
|not accessible to webserver
|No
|---- bgcolor=#FFFF99 align=left
|/home/www/pictures/phpgedview
|../pictures/phpgedview
|
|Yes
|}
 
With version 4.1.2 there is a new feature, '''[[Media Firewall]]''', which allows you to protect the images from being accessed directly. Only the first two examples, default and the ''pictures/media'' forms will work with Media Firewall.

===Multimedia Directory levels to Keep===

This setting allows you to select the depth of directories within your defined media folder/directory.

;Depth Value = 0
:In this case ALL files are contained in the media directory

media_directory|--File 1
|--File 2
|--File 3
;Depth Value = 1

:This will allow the user some ability to organise their files to avoid overwritting files with the same name etc.
media_directory|--Directory 1|--File 1
|--File 2
|--File 3
|--Directory 2|--File 1
|--File 2
|--File 3

:In this case directories could be created for indiviuals, family groups, media type and the the list goes on.
;Depth Value = 2
:This will allow even greater segrgation of files by directory/folder structure.
media_directory|--Directory 1|--Directory A|--File 1
|--File 2
|--File 3
|--Directory B|--File 1
|--File 2
|--File 3
|-Directory 2|--Directory C|--File 1
|--File 2
|--File 3
|--Directory D|--File 1
|--File 2
|--File 3

<strike>A value of 0 will ignore all directories in the file path for the media object. A value of 1 will retain the first directory containing this image. Increasing the numbers increases number of parent directories to retain in the path.

For example, if you link an image in your GEDCOM with a path like C:\Documents and Settings\User\My Documents\My Pictures\Genealogy\Surname Line\grandpa.jpg, a value of 0 will translate this path to ./media/grandpa.jpg. A value of 1 will translate this to ./media/Surname Line/grandpa.jpg, etc. Most people will only need to use a 0. However, it is possible that some media objects kept in different directories have identical names and would overwrite each other when this option is set to 0. Non-zero settings allow you to keep some organization in your media thereby preventing name collisions.</strike>

===Width of Generated Thumbnails===
[[Image:4_multimedia_5.jpg|framed|left]]
 
This is the width (in pixels) that the program will use when automatically generating thumbnails. The default setting is 100.

===Automatically Generated Thumbnails===
[[Image:4_multimedia_6.jpg|framed|left]]
 
Should the system automatically generate thumbnails for images that do not have them. Your PHP installation might not support this functionality.

===Use Thumbnail===
This option determines whether images associated with persons, families, or sources are shown by using a thumbnail image or whether the main image is used. Several pages, such as the Media Viewer page, also honor this setting. The Manage Media and Media List pages, on the other hand, always use the thumbnail.

When this option is set to '''Yes''', all pages, except the Charts, will show the thumbnail image exactly as it is in the database. This means that no size checks are performed, and if the thumbnail is larger than normal, the display results can be surprising.

When this option is set to '''No''', your browser will reduce the main image to thumbnail size before showing it on the Person, Family, and Source pages. This image will have a width of 150 pixels, and will be shown with a border (when the existing thumbnail is used, there is no border). The Media Viewer page will show the main picture with a maximum width of 300 pixels. If the main picture is smaller, the Media Viewer will show it in full size.

You should avoid setting this option to '''No''' because PhpGedView will send the full-sized image to the browser even when the browser will be showing a smaller version. Thus, this option can result in excessive data transfer between PhpGedView and the browser.

===Show Highlight Images in People boxes===
[[Image:4_multimedia_7.jpg|framed|left]]
 
If you have enabled multimedia in your site, you can have PhpGedView display a thumbnail image next to the person's name in charts and boxes.

<del>Currently, PhpGedView uses the first multimedia object listed in the GEDCOM record as the highlight image. For people with multiple images, you should arrange the multimedia objects such that the one you wish to be highlighted appears first, before any others.</del> Needs replacement reference [[User:MarekZ|MarekZ]] 07:48, 6 April 2008 (EST)

===Use Media Viewer===
When this option is '''Yes''', clicking on images will produce the Media Viewer page. This page shows the details of the image. If you have sufficient rights, you can also edit these details.

When this option is '''No''', clicking on images will produce a full-size image in a new window.

===Use Thumbmail for Main Picture on Individual Page===
[[Image:4_multimedia_8.jpg|framed|left]]
 
Depending on how you want to store your images, it may be better for you to use thumbnails for the picture next to the name on the Individual page.

If your main images are very large, they can take a long time to download and if your thumbnails are high enough quality they could be used in place of the full resolution image. Set this item to Yes to use thumbnails or leave it as No to use the full resolution image.
'''''Note:'''' this feature is removed in version 4.1.4

===Show File Name in Media Viewer===
The Media Viewer can show the name of the Media file being viewed. This option determines whether that file name is shown to users or not.

You may want to hide the file name for security reasons.

===Show download link in Media Viewer===
The Media Viewer can show a link which, when clicked, will download the Media file to the local PC.

You may want to hide the download link for security reasons.

==Media Firewall==
{{main|Media Firewall}}
Media Firewall enforces your PGV privacy settings. Without the Media Firewall, PGV can "hide" the urls to your private media items, but if someone figures out the right urls they can easily view them. The Media Firewall ensures that nobody can view your confidential images.

Media Firewall can also watermark your images to make it harder for someone to take and post them on another site. You can choose to watermark images for only certain user types, if you wish.
===Use Media Firewall===
Select if you want to use the Media Firewall feature

===Media Firewall Root Directory===
Directory in which the protected Media directory can be created. When this field is empty, the default index directory will be used.

===Protect Thumbnails of Protected Images===
When an image is in the protected Media directory, should its thumbnail be protected as well?

===Who can view non-watermarked images?===
If the Media Firewall is enabled, users will see watermarks if they do not have the privilege level specified here. see [[Privacy File]] for list of privileges.

===Add watermarks to thumbnails?===
If the Media Firewall is enabled, should thumbnails be watermarked? Your media lists will load faster if you don't watermark the thumbnails.

===Store watermarked full size images on server?===
If the Media Firewall is enabled, should copies of watermarked full size images be stored on the server in addition to the same images without watermarks?

When set to '''Yes''', full-sized watermarked images will be produced more quickly at the expense of higher server disk space requirements.

===Store watermarked thumbnails on server?===
If the Media Firewall is enabled, should copies of watermarked thumbnails be stored on the server in addition to the same thumbnails without watermarks?

When set to '''Yes''', media lists containing watermarked thumbnails will be produced more quickly at the expense of higher server disk space requirements.

[[Category:Administrators Guide]]
[[Category:phpGedView]]

Setting File Permissions

2010-07-27T22:41:16Z

Ggpauly: Minor edits and changed link to additional security page

==Introduction==

Once you've uploaded PGV to your webserver, you should set file access permissions to limit access to scripts and data files. If the permissions are too restrictive, PhpGedView won't be able to run. If the permissions are too lax, you risk unauthorised access to your data and your server.

==Prerequisites==

Before proceeding, you need to have some means of changing file permissions. This can be easily and securely done using a secure shell login (ssh). However many users will not have this ability, and instead will need to use an FTP client. [http://sourceforge.net/projects/filezilla FileZilla] is an excellent open source FTP client, and if you are using Firefox, a [http://fireftp.mozdev.org/ FireFTP] add-on works very well; there are many other FTP clients are available. You should make sure your FTP client allows you to change file permissions as some programs do not provide this facility. The Microsoft command-line FTP utility is one such unsuitable program.

''(FTP has a number of security weaknesses. An alternative called Secure-FTP or SFTP exists which provides much better security. However, not all hosts allow you to connect via SFTP. If you have the option of using SFTP, then you are recommended to do so. If you don't understand this sentence then just ignore it and continue with FTP. The security risks, while real, are relatively small.)''

It is helpful to understand unix file permissions and the [[chmod]] command, but not strictly necessary. At the very least, you should understand that your files can be accessed by two types of people: '''you''' and '''everyone else'''. You can set different permissions for '''you''' and '''everyone else'''. Permissions include the ability to read files, write files, access subdirectories and browse subdirectories.

==Identifying the directories on your server==

There are a number of ways in which your ISP can configure the web server. These instructions assume you've got a unix-style operating system and a standard configuration. If your server is set up differently, you can still apply the concepts below, but will need to adjust directories, access-permissions, etc.

Firstly, we need to identify a three directories; the home, web and installation directories

===home directory===
This is the login directory of your user accout. When you connect by FTP, you will normally be placed in this directory by default. It will typically be called "/home/UserName" or "/users/UserName". On some servers, you can't see the path, and your home directory will be displayed as just "/".

===web directory===
This will either be the same as your home directory, or a subdirectory such as "public_html" or "www.YourDomain.com".

===PhpGedView installation directory===
This will either be the same as your web directory, or a subdirectory such as "PhpGedView". If you use a subdirectory, you will access your site as something like www.YourDomain.com/PhpGedView. If you don't use a subdirectory (i.e. your PhpGedView installation directory is the same as your web directory), then you will access your site as just www.YourDomain.com

As you can see, these three directories may all be the same, they may all different, or two may be the same. A typical configuration might look like this:

/home/UserName/ # home directory
/home/UserName/public_html # web directory
/home/UserName/public_html/PhpGedView # installation directory

This user might access their site with the URL <nowiki>http://www.MyIsp.com/~UserName/PhpGedView</nowiki>

==Securing the index directory==

If your home directory is different to your web directory, you can gain a little extra security by moving PhpGedView's index directory from the installation directory to the home directory. Once you've set your file permissions, you can do this by following the instructions [[Additional Security Procedures|here]]

==Apache configuration==

If you are using Apache as your webserver (the majority of ISPs use Apache), then it can run PHP scripts in one of two modes. The difference between the two modes is the identity of the process that runs PHP scripts.

===Apache Module===
When Apache runs PHP as a module, it executes scripts as itself. This is typically a lowly-privileged user account such as "www-user", "www-data", "nobody" or "web". This means that you need to set permissions so that this lowly-priveleged user can access your files and directories. In other words, you have to make files accessible to '''everyone else'''.

===CGI===
When apache runs PHP scripts using CGI, it executes scripts as '''you'''. This means that you can set more restrictive permissions, as only '''you''' need to access certain files.

How can you tell which of the two modes you have? The answer is to look for a file that has been created by PhpGedView, such as uploaded media/gedcom/log files, using your FTP client. If the file is owned by '''you''' (i.e. your login name), then PHP is run in CGI mode. If it is owned by "www-user" or similar, then PHP is run as an apache module. If you don't know or don't understand the question, assume your scripts are run as an apache module. The settings for this option will work for both modes.

==Setting Permissions==

You need to set different permissions for files and directories. The table
below shows which permissions need to be given to which file or directory.

To save space in this table, we use [home], [web] and [install] to refer to
the directories identifed above. '''*''' means all files in the directory.

<table border='1'>
<tr>
<th>Directory</th>
<th>File</th>
<th>Apache module</th>
<th>CGI</th>
<th>Notes</th>
</tr>

<tr>
<td>[home], [web] and [install]</td>
<td></td>
<td>711</td>
<td>711</td>
<td>apache needs to access (but not browse) these directories</td>
</tr>

<tr>
<td></td>
<td>[install]/config.php </td>
<td>444</td>
<td>400</td>
<td>PHP needs to write to this file when editing your site config using the editconfig.php page. You must temporarily change this to 666 (module) or 600 (CGI) to save your changes.</td>
</tr>

<tr>
<td>[install]/index (and subdirectories)</td>
<td></td>
<td>777</td>
<td>700</td>
<td>PHP needs to create/delete files in this directory.</td>
</tr>

<tr>
<td></td>
<td>[install]/index/* (and files in subdirectories)</td>
<td>666</td>
<td>600</td>
<td>PHP needs to read/write these files.</td>
</tr>

<tr>
<td>[install]/media (and subdirectories)</td>
<td></td>
<td>777</td>
<td>711</td>
<td>apache needs to access this directory. PHP needs to browse it.</td>
</tr>

<tr>
<td></td>
<td>[install]/media/* (and files in subdirectories)</td>
<td>666</td>
<td>644</td>
<td>apache needs to read these files. PHP needs to write them.</td>
</tr>

<tr>
<td>[install]/modules (and subdirectories)</td>
<td></td>
<td>777</td>
<td>711</td>
<td>apache needs to access this directory. PHP needs to browse it.</td>
</tr>

<tr>
<td></td>
<td>[install]/modules/* (and files in subdirectories)</td>
<td>666</td>
<td>644</td>
<td>apache needs to read these files. PHP needs to write them.</td>
</tr>

<tr>
<td>all other directories and subdirectories in [install]</td>
<td></td>
<td>711</td>
<td>711</td>
<td>PHP needs to access these directories</td>
</tr>

<tr>
<td></td>
<td>all other files in [install] and other subdirectories</td>
<td>644</td>
<td>644</td>
<td>PHP needs to read these files</td>
</tr>

</table>