INSTALL.txt

   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 encryption of key
  21 exchange conversations
  22 encryption support
  23                 - PHP *command line* access with register_argc_argv set to true in the
  24 php.ini file
  25                 - curl, gd, mysql, and openssl extensions
  26                 - some form of email server or email gateway such that PHP mail() works
  27                 - mcrypt (optional; used for end-to-end message encryption)
  28
  29         - Mysql 5.x
  30
  31         - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  32 (Windows)
  33
  34         - Installation into a top-level domain or sub-domain (without a
  35 directory/path component in the URL) is preferred. Directory paths will
  36 not be as convenient to use and have not been thoroughly tested.
  37
  38         [Dreamhost.com offers all of the necessary hosting features at a
  39 reasonable price. If your hosting provider doesn't allow Unix shell access,
  40 you might have trouble getting everything to work.]
  41
  42 2. Unpack the Friendika files into the root of your web server document area.
  43
  44         - If you copy the directory tree to your webserver, make sure
  45         that you also copy .htaccess - as "dot" files are often hidden
  46         and aren't normally copied.
  47
  48 3. Create an empty database and note the access details (hostname, username,
  49 password, database name).
  50
  51 4. Visit your website with a web browser and follow the instructions. Please
  52 note any error messages and correct these before continuing.
  53
  54 5. *If* the automated installation fails for any reason, check the following:
  55
  56         - ".htconfig.php" exists
  57                 If not, edit htconfig.php and change system settings. Rename
  58 to .htconfig.php
  59         -  Database is populated.
  60                 If not, import the contents of "database.sql" with phpmyadmin
  61 or mysql command line
  62
  63 6. At this point visit your website again, and register your personal account.
  64 Registration errors should all be recoverable automatically.
  65 If you get any *critical* failure at this point, it generally indicates the
  66 database was not installed correctly. You might wish to move/rename
  67 .htconfig.php to another name and empty (called 'dropping') the database
  68 tables, so that you can start fresh.
  69
  70 7. Set up a cron job or scheduled task to run the poller once every 5-10
  71 minutes to pick up the recent "public" postings of your friends. Example:
  72
  73         cd /base/directory; /path/to/php include/poller.php
  74
  75 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  76
  77 If you are using a Linux server, run "crontab -e" and add a line like the
  78 one shown, substituting for your unique paths and settings:
  79
  80 */10 * * * *    cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  81
  82 You can generally find the location of PHP by executing "which php". If you
  83 have troubles with this section please contact your hosting provider for
  84 assistance. Friendika will not work correctly if you cannot perform this step.
  85