]> git.mxchange.org Git - friendica.git/blobdiff - INSTALL
highlight any messages on page newer than 12 hours
[friendica.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 41275f6636d2f493958441a9cb1a6089669460b8..ceb73c3b9cd9b79e28cc51a91d31f326c0cc6ac1 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,64 +1,72 @@
 
-Mistpark Installation
+Friendika Installation
+
+We've tried very hard to ensure that Friendika will run on commodity hosting 
+platforms - such as those used to host Wordpress blogs and Drupal websites. 
+But be aware that Friendika is more than a simple web application. It is a 
+complex communications system which more closely resembles an email server 
+than a web server. For reliability and performance, messages are delivered in
+the background and are queued for later delivery when sites are down. This
+kind of functionality requires a bit more of the host system than the typical
+blog. Not every PHP/MySQL hosting provider will be able to support Friendika. 
+Many will. But please review the requirements and confirm these with your 
+hosting provider prior to installation.
 
-This is an early release. Some manual installation is required at this time. 
 
 1. Requirements
        - Apache with mod-rewrite enabled and "Options All" so you can use a 
 local .htaccess file
 
-       - PHP > 5.1. The later the better. You'll need 5.3 for full openssl 
+       - PHP > 5.1. The later the better. You'll need 5.3 for encryption of key
+exchange conversations
 encryption support
-
-       - PHP *command line* access with register_argc_argv set to true in the 
+               - PHP *command line* access with register_argc_argv set to true in the 
 php.ini file
+               - curl, gd, mysql, and openssl extensions
+               - mcrypt (optional; used for end-to-end message encryption)
 
        - Mysql 5.x
 
        - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
 (Windows)
-       
+
+       - Installation into a top-level domain or sub-domain (without a 
+directory/path component in the URL) is preferred. Directory paths will
+not be as convenient to use and have not been thoroughly tested.  
+
        [Dreamhost.com offers all of the necessary hosting features at a 
 reasonable price. If your hosting provider doesn't allow Unix shell access, 
 you might have trouble getting everything to work.] 
 
-2. Put this directory into the root of your web server document area.
+2. Unpack the Friendika files into the root of your web server document area.
 
        - If you copy the directory tree to your webserver, make sure
        that you also copy .htaccess - as "dot" files are often hidden 
        and aren't normally copied.
 
-       - To use a subdirectory of your main domain, set the 
-       config variable $a->path to the relative subdir
-       in .htconfig.php - for example to use http://example.com/test - 
-       use
-               $a->path = 'test';
-
-       In this case, you cannot use the web installer. 
-       Skip step 3 and proceed to step 4 - especially steps 4a and 4b.
-
-       - Everything will work much better if you can dedicate a domain 
-       or subdomain so that you don't require an extra server path. 
+3. Create an empty database and note the access details (hostname, username, 
+password, database name).
 
-3. Visit your website with a web browser and follow the instructions. 
+4. Visit your website with a web browser and follow the instructions. Please 
+note any error messages and correct these before continuing.
 
-4. *If* the automated installation fails for any reason, check the following:
+5. *If* the automated installation fails for any reason, check the following:
 
-       4a. ".htconfig.php" exists 
+       - ".htconfig.php" exists 
                If not, edit htconfig.php and change system settings. Rename 
 to .htconfig.php
-       4b. Database is populated.
+        Database is populated.
                If not, import the contents of "database.sql" with phpmyadmin 
 or mysql command line
 
-5. At this point visit your website again, and register your personal account. 
+6. At this point visit your website again, and register your personal account. 
 Registration errors should all be recoverable automatically. 
 If you get any *critical* failure at this point, it generally indicates the
 database was not installed correctly. You might wish to move/rename 
 .htconfig.php to another name and empty (called 'dropping') the database 
 tables, so that you can start fresh.  
 
-6. Set up a cron job or scheduled task to run the poller once every 5-10 
+7. Set up a cron job or scheduled task to run the poller once every 5-10 
 minutes to pick up the recent "public" postings of your friends. Example:
 
        cd /base/directory; /path/to/php include/poller.php
@@ -68,9 +76,9 @@ Change "/base/directory", and "/path/to/php" as appropriate for your situation.
 If you are using a Linux server, run "crontab -e" and add a line like the 
 one shown, substituting for your unique paths and settings:
 
-*/5 * * * *    cd /home/myname/mywebsite; /usr/bin/php include/poller.php
+*/10 * * * *   cd /home/myname/mywebsite; /usr/bin/php include/poller.php
 
 You can generally find the location of PHP by executing "which php". If you 
 have troubles with this section please contact your hosting provider for 
-assistance. Mistpark will not work correctly if you cannot perform this step.
-  
\ No newline at end of file
+assistance. Friendika will not work correctly if you cannot perform this step.
+