INSTALL

   1
   2 Friendika Installation
   3
   4 We've tried very hard to ensure that Friendika will run on commodity hosting
   5 platforms - such as those used to host Wordpress blogs and Drupal websites.
   6 But be aware that Friendika is more than a simple web application. It is a
   7 complex communications system which more closely resembles an email server
   8 than a web server. For reliability and performance, messages are delivered in
   9 the background and are queued for later delivery when sites are down. This
  10 kind of functionality requires a bit more of the host system than the typical
  11 blog. Not every PHP/MySQL hosting provider will be able to support Friendika.
  12 Many will. But please review the requirements and confirm these with your
  13 hosting provider prior to installation.
  14
  15
  16 1. Requirements
  17         - Apache with mod-rewrite enabled and "Options All" so you can use a
  18 local .htaccess file
  19
  20         - PHP > 5.1. The later the better. You'll need 5.3 for full openssl
  21 encryption support
  22                 - PHP *command line* access with register_argc_argv set to true in the
  23 php.ini file
  24                 - curl, gd, mysql, and openssl extensions
  25
  26         - Mysql 5.x
  27
  28         - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  29 (Windows)
  30
  31         - At this time we require the installation to be at the top level of a
  32 domain or sub-domain (without an extra path). This requirement may change in
  33 the future.
  34
  35         [Dreamhost.com offers all of the necessary hosting features at a
  36 reasonable price. If your hosting provider doesn't allow Unix shell access,
  37 you might have trouble getting everything to work.]
  38
  39 2. Unpack the Friendika files into the root of your web server document area.
  40
  41         - If you copy the directory tree to your webserver, make sure
  42         that you also copy .htaccess - as "dot" files are often hidden
  43         and aren't normally copied.
  44
  45 3. Create an empty database and note the access details (hostname, username,
  46 password, database name).
  47
  48 4. Visit your website with a web browser and follow the instructions. Please
  49 note any error messages and correct these before continuing.
  50
  51 5. *If* the automated installation fails for any reason, check the following:
  52
  53         - ".htconfig.php" exists
  54                 If not, edit htconfig.php and change system settings. Rename
  55 to .htconfig.php
  56         -  Database is populated.
  57                 If not, import the contents of "database.sql" with phpmyadmin
  58 or mysql command line
  59
  60 6. At this point visit your website again, and register your personal account.
  61 Registration errors should all be recoverable automatically.
  62 If you get any *critical* failure at this point, it generally indicates the
  63 database was not installed correctly. You might wish to move/rename
  64 .htconfig.php to another name and empty (called 'dropping') the database
  65 tables, so that you can start fresh.
  66
  67 7. Set up a cron job or scheduled task to run the poller once every 5-10
  68 minutes to pick up the recent "public" postings of your friends. Example:
  69
  70         cd /base/directory; /path/to/php include/poller.php
  71
  72 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  73
  74 If you are using a Linux server, run "crontab -e" and add a line like the
  75 one shown, substituting for your unique paths and settings:
  76
  77 */10 * * * *    cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  78
  79 You can generally find the location of PHP by executing "which php". If you
  80 have troubles with this section please contact your hosting provider for
  81 assistance. Friendika will not work correctly if you cannot perform this step.
  82