diff options
| -rw-r--r-- | readme.html | 99 |
1 files changed, 47 insertions, 52 deletions
diff --git a/readme.html b/readme.html index ae5f2c5f53..6e51717253 100644 --- a/readme.html +++ b/readme.html @@ -1,19 +1,12 @@ -<?php -/** - * webtrees +<!-- +Copyright (C) 2013 webtrees Development Team. All rights reserved. - * Version 1.0 - * Copyright (C) 2012 webtrees Development Team. All rights reserved. - * - * This and other information can be found on line at - * http://webtrees.net - * - * The installation instructions can also be found in the wiki at: - * http://webtrees.net/mediawiki/index.php/Main_Page - * - * # $Id$ - */ -?> +This and other information can be found on line at http://webtrees.net + +The installation instructions can also be found in the wiki at: +http://webtrees.net/mediawiki/index.php/Main_Page + +--> <!DOCTYPE html> <html lang="en" dir="ltr"> <head><meta charset="UTF-8"> @@ -28,7 +21,7 @@ .back {color: #81A9CB; float:right;} </style> </head><body> -<a name="top"><h1><b>webtrees</b> ReadMe File</h1></a> +<a id="top"><h1><b>webtrees</b> ReadMe File</h1></a> <p><b>Note: </b> This information is also available at <a href="http://wiki.webtrees.net/">the <b>webtrees</b> WIKI</a></p> <h2>CONTENTS</h2> <ol> @@ -42,9 +35,9 @@ <li><a href="#backup">BACKUP</a></li> <li><a href="#convert">CONVERTING from PHPGEDVIEW</a></li> </ol> -<hr width="100%"> +<hr> <!-- LICENSE --> -<div style="float:left;"><a name="licence"><h3>LICENSE</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="licence"><h3>LICENSE</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> * <b>webtrees: Web based Family History software</b><br> * Copyright (C) 2013 webtrees development team.<br> *<br> @@ -58,9 +51,9 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY <br><br> See the file GPL.txt included with this software for more detailed licensing information. <br><br> -<hr width="100%"> +<hr> <!-- INTRODUCTION --> -<div style="float:left;"><a name="intro"><h3>INTRODUCTION</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="intro"><h3>INTRODUCTION</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> <b>webtrees</b> is the web's leading online collaborative genealogy application. <ul> <li>It works from standard GEDCOM files, and is therefore compatible with every major desktop application.</li> @@ -70,32 +63,36 @@ See the file GPL.txt included with this software for more detailed licensing inf <br><br> <b>webtrees</b> is Open Source software that has been produced by people from many countries freely donating their time and talents to the project. All service, support, and future development is dependent on the time developers are willing to donate to the project, often at the expense of work, recreation, and family. Beyond the few donations received from users, developers receive no compensation for the time they spend working on the project. There is also no outside source of revenue to support the project. Please consider these circumstances when making support requests and consider volunteering your own time and skills to make the project even stronger and better. <br><br> -<hr width="100%"> +<hr> <!-- SYSTEM REQUIREMENTS --> -<div style="float:left;"><a name="system"><h3>SYSTEM REQUIREMENTS</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="system"><h3>SYSTEM REQUIREMENTS</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> To install <b>webtrees</b>, you need: <br> <ul> <li>A webserver. Apache and IIS are the most common types. There are no requirements to use a specific type or version.</li> <li>Approximately 65MB of disk space for the application files, plus whatever is needed for your multi-media files, GEDCOM files and database.</li> - <li>PHP 5.2.3 or later. Note that many web hosts offer *both* PHP4 and PHP5, typically with PHP4 as the default. If this is the case, you will be able to switch between the two using a control panel or a configuration file. Refer to your web host's support documentation for details.</li> - <ul> - <li>PHP should be configured with the PHP/PDO library for MySQL. This is a server configuration option. It is enabled by default on most hosts. See <a href="http://php.net/pdo">http://php.net/pdo</a></li> - <li>PHP should be configured to allow sufficient server resources (memory and execution time) for the size of your system. Typical requirements are:</li> - <ul> - <li>Small systems (500 individuals): 16-32MB, 10-20 seconds</li> - <li>Medium systems (5000 individuals): 32-64MB, 20-40 seconds</li> - <li>Large systems (50000 individuals): 64-128MB, 40-80 seconds</li> - </ul> - </ul> + <li>PHP 5.3.2 or later. Note that many web hosts offer *both* PHP4 and PHP5, typically with PHP4 as the default. If this is the case, you will be able to switch between the two using a control panel or a configuration file. Refer to your web host's support documentation for details.</li> + <li> + <ul> + <li>PHP should be configured with the PHP/PDO library for MySQL. This is a server configuration option. It is enabled by default on most hosts. See <a href="http://php.net/pdo">http://php.net/pdo</a></li> + <li>PHP should be configured to allow sufficient server resources (memory and execution time) for the size of your system. Typical requirements are:</li> + <li> + <ul> + <li>Small systems (500 individuals): 16-32MB, 10-20 seconds</li> + <li>Medium systems (5000 individuals): 32-64MB, 20-40 seconds</li> + <li>Large systems (50000 individuals): 64-128MB, 40-80 seconds</li> + </ul> + </li> + </ul> + </li> <li>MySQL 5.0.13 or later. Note that <b>webtrees</b> can share a single database with other applications, by choosing a unique table prefix during configuration. If the number of databases is not restricted, you can set up a database purely for use by <b>webtrees</b> and create a separate user and password for only your genealogy.</li> <li>Internet browser compatability. <b>webtrees</b> supports the use of most current versions of open-source browsers such as Firefox, Chrome, and Safari. We will do our best to support others such as Opera and Internet Explorer, though not their earlier versions. Currently many things do not work well in IE7, and some not in IE8 either. We strongly recommend anyone using these obsolete browsers upgrade as soon as possible. We are also aware that IE and Opera browsers provide poor RTL language support generally, so cannot recommend those for sites requiring RTL languages.</li> <li>To view sites that contain both left-to-right and right-to-left text (e.g. English data on Hebrew pages), you will need to use a browser that provides support for the HTML5 dir="auto" attribute. At present, only browsers based on the WebKit engine (Chrome and Safari) have this. The Gecko (Firefox) and Presto (Opera) engines promise to provide this soon.</li> <li>HTML Frames. Note that <b>webtrees</b> uses cookies to track login sessions. Sites that make <b>webtrees</b> pages available inside an HTML Frames will encounter problems with login for versions 7, 8, and 9 of Internet Explorer. IE users should review the Privacy settings Tools / Internet Options for more details.</li> </ul> -<hr width="100%"> +<hr> <!-- INSTALLATION --> -<div style="float:left;"><a name="install"><h3>INSTALLATION</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="install"><h3>INSTALLATION</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> Installing <b>webtrees</b> is really easy. All you need is a webserver with PHP and MySQL. Almost every web hosting service provides these, but be sure to confirm that those supplied meet or exceed the minimum system requirements. <br><br> <ol> @@ -110,6 +107,7 @@ Installing <b>webtrees</b> is really easy. All you need is a webserver with PHP So, after installation, you'll be directed to the GEDCOM (family tree) administration page, where you'll need to select one of the following options: <ol> <li>On successful completion of all steps you will be taken to the GEDCOM (family tree) administration page where you can:</li> + <li> <ul> <li>UPLOAD a GEDCOM file from your local machine</li> <li>ADD a GEDCOM file from your server, (if your GEDCOM file is too large to upload, you can copy it to the webtrees/data folder, and load it from there)</li> @@ -118,9 +116,9 @@ So, after installation, you'll be directed to the GEDCOM (family tree) administr </ul> </ol> There are <i>lots</i> of configuration options. You'll probably want to review the privacy settings first. Don't worry too much about all the other options - the defaults are good for most people. If you get stuck, there's lots of built-in help and you can get friendly advice from the <a href="http://webtrees.net/forums">help</a> forum. -<hr width="100%"> +<hr> <!-- UPGRADING --> -<div style="float:left;"><a name="upgrade"><h3>UPGRADING</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="upgrade"><h3>UPGRADING</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> Upgrading <b>webtrees</b> is quick and easy. It is strongly recommended that you upgrade your installation whenever a new version is made available. Even minor <b>webtrees</b> version updates usually contain a significant number of bug fixes as well as interface improvements and program enhancements. The Administration page of your <b>webtrees</b> installation will display a notification whenever a new version is available. <ol> <li>Now would be a good time to make a <a href="#backup">backup</a>. </li> @@ -133,9 +131,9 @@ Upgrading <b>webtrees</b> is quick and easy. It is strongly recommended that you <p><i>NOTE for anyone using custom code (modules, themes, etc.). It is <u>very likely</u> that your custom code will not work when you upgrade <b>webtrees</b>. <span style="color:red;">We recommend that you disable all custom code before you apply the upgrade.</span> Disable custom modules, switch over to a standard theme, and remove any code "hacks". Once the upgrade is complete and you are satisfied your site is fully operational contact the source of those modules or themes for a new version.</i></p> <p><i>GENERAL NOTE: Depending on the changes in the new files, your browser configuration and possibly other factors, it is always wise to clear both the <b>webtrees</b> cache and your browser cache immediately after the upgrade is completed. The <b>webtrees</b> cache can be cleared simply by going to Administration -> Cleanup data directory and deleting the cache.</i></p> If you have any problems or questions, help is available on the <a href="http://webtrees.net/forums">webtrees forum</a>. -<hr width="100%"> +<hr> <!-- GEDCOM FILES --> -<div style="float:left;"><a name="gedcom"><h3>GEDCOM (family tree) FILES</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="gedcom"><h3>GEDCOM (family tree) FILES</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> When you ADD, IMPORT or UPLOAD a family tree (GEDCOM) file in <b>webtrees</b> the data from the file is all transferred to the database tables. The file itself is no longer used or required by <b>webtrees</b> <br> <ul> @@ -146,14 +144,15 @@ When you ADD, IMPORT or UPLOAD a family tree (GEDCOM) file in <b>webtrees</b> th When or if you change your genealogy data outside of <b>webtrees</b>, it is not necessary to delete your GEDCOM file or database from <b>webtrees</b> and start over. Follow these steps to update a GEDCOM that has already been imported: <ol> <li>Decide if you want to IMPORT or UPLOAD your new GEDCOM file.</li> + <li> <ul> <li>Use UPLOAD if your family tree file is smaller than your server's PHP file upload limit (often 2MB).The new file can have any name you choose.</li> <li>Use IMPORT for larger files. In this case you need to use FTP to first copy your file to the webtrees/data folder. Either copy over the existing file, or use a different name.</li> </ul> + </li> <li>From the Administration page, go to your <b>webtrees</b> Family trees (GEDCOM) configuration page. On the line relating to this particular family tree (GEDCOM) file (or a new one) click either IMPORT or UPLOAD.</li> <li>Take careful note of the media items option (<i>"If you have created media objects in <b>webtrees</b>, and have edited your gedcom off-line using a program that deletes media objects, then tick this box to merge the current media objects with the new GEDCOM."</i>) In most cases you should leave this box <b>UNCHECKED</b>.</li> <li>Click "SAVE". <b>webtrees</b> will validate the GEDCOM again before importing. During this process, <b>webtrees</b> copies your entire family tree (GEDCOM file) to a 'chunk' table within your database. Depending on the coding of your file, its file size and the capabilities of your server and the supporting software, this may take some time. <b>No progress bar will show while the data is being copied</b> and should you navigate away from this page, the process is suspended. It will start again when you return to the Family Tree management page.</li> - <li><strike>You can use a ZIP file to upload the GEDCOM, but only if you use the UPLOAD option. The filename can be anything you choose.</strike> NOTE: The ability to upload ZIP files does not currently work. If your GEDCOM file is too large to upload, you should use the IMPORT option.</li> </ol> <p><b>FORMAT</b></p> Every Family History program has its own method of creating GEDCOM files, and differing output format options to select from. <b>webtrees'</b> import routines can read many different formats, but not necessarily all. If your software has a "UTF8" option you should always use that. However, <b>webtrees</b> has been tested with these alternative formats: @@ -163,21 +162,17 @@ Every Family History program has its own method of creating GEDCOM files, and di <li>DOS - imports OK, but is slow due to the translation into UTF8 as part of the import process.</li> <li>ANSEL - currently will not import. Gives warning <em>Error: cannot convert GEDCOM file from ANSEL encoding to UTF-8 encoding.</em> Later releases of <b>webtrees</b> may include translation from ANSEL to UTF8, but this is not a simple process.</li? </ul> -<hr width="100%"> +<hr> <!-- SECURITY --> -<div style="float:left;"><a name="security"><h3>SECURITY</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="security"><h3>SECURITY</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> <b>Security in <i>webtrees</i> means ensuring your site is safe from unwanted intrusions, hacking, or access to data and configuration files. The developers of <i>webtrees</i> regard security as an extremely important part of its development and have made every attempt to ensure your data is safe.</b> <br><br> The area most at risk of intrusion would be the /data folder that contains your config.ini.php file, and various temporary files. If you are concerned there may be a risk there is a very simple test you can do: try to fetch <b>config.ini.php</b> by typing <b>http:// </b><i>url to your site</i><b> /data/config.ini.php</b> in your web browser. <br><br> The most likely result is an "access denied" message like this: -<table border="1px" cellpadding="5px" cellspacing="0"> - <tr> - <td> - <font size="4"><b>Forbidden</b></font><br><br>You don't have permission to access /data/xxxx.ged on this server. - </td> - </tr> -</table> +<div style="border:solid black 1px; padding:10px; margin: 10px;"> + <b>Forbidden</b><br><br>You don't have permission to access /data/xxxx.ged on this server. +</div> <br> This indicates that the protection built into <b>webtrees</b> is working, and no further action is required. <br><br> @@ -205,9 +200,9 @@ You will have <b>two</b> data directories: <br><br> <b>webtrees</b> supports https access. If your website is configured with mandatory or optional https support <b>webtrees</b> will operate correctly in either mode.<br><br> If your website is configured with optional https support, <b>webtrees</b> can be configured to switch to https at login. To enable https at login, set the Login URL setting on the Admin --> Site Administration --> Configuration page to your https login URL, which is often in the form https://example.com/admin.php (substitute your domain for example.com). Warning: misconfiguration can disable your login links. If this occurs, access the login by typing the correct URL directly into your browser's address input. -<hr width="100%"> +<hr> <!-- BACKUP --> -<div style="float:left;"><a name="backup"><h3>BACKUP</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="backup"><h3>BACKUP</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> Backups are good. Whatever problem you have, it can always be fixed from a good backup. <br><br> To make a backup of webtrees, you need to make a copy of the following @@ -217,9 +212,9 @@ To make a backup of webtrees, you need to make a copy of the following <li>The tables in the database. Freely available tools such as phpMyAdmin allow you to do this in one click.</li> </ol> Remember that most web hosting services do NOT backup your data, and this is your responsibility. -<hr width="100%"> +<hr> <!-- CONVERSION --> -<div style="float:left;"><a name="convert"><h3>CONVERTING from PHPGEDVIEW</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> +<div style="float:left;"><a id="convert"><h3>CONVERTING from PHPGEDVIEW</h3></a></div><div class="back"><a href="#top">back to top</a></div><div style="clear:both;"></div> If you are moving to <b>webtrees</b> from an existing PhpGedView ("PGV") setup, and your PGV install meets certain requirements, <b>webtrees</b> has provided a "wizard" to help make the transfer of the majority of your data a relatively quick and painless operation. See exceptions noted below. Please note that we have designed this wizard so as to not disturb your existing PGV installation, leaving all those settings, data and your website intact and fully functional. <br><br> The requirements are: |