INSTALL

   1
   2 Friendika Installation
   3
   4 1. Requirements
   5         - Apache with mod-rewrite enabled and "Options All" so you can use a
   6 local .htaccess file
   7
   8         - PHP > 5.1. The later the better. You'll need 5.3 for full openssl
   9 encryption support
  10                 - PHP *command line* access with register_argc_argv set to true in the
  11 php.ini file
  12                 - curl, gd, and openssl extensions
  13
  14         - Mysql 5.x
  15
  16         - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  17 (Windows)
  18
  19         [Dreamhost.com offers all of the necessary hosting features at a
  20 reasonable price. If your hosting provider doesn't allow Unix shell access,
  21 you might have trouble getting everything to work.]
  22
  23 2. Put this directory into the root of your web server document area.
  24
  25         - If you copy the directory tree to your webserver, make sure
  26         that you also copy .htaccess - as "dot" files are often hidden
  27         and aren't normally copied.
  28
  29         - To use a subdirectory of your main domain, set the
  30         config variable $a->path to the relative subdir
  31         in .htconfig.php - for example to use http://example.com/test -
  32         use
  33                 $a->path = 'test';
  34
  35         NOTE: This has NOT been fully tested!
  36         In this case, you cannot use the web installer.
  37         Skip step 4 and proceed to step 5 - especially steps 5a and 5b.
  38
  39         - Everything will work much better if you can dedicate a domain
  40         or subdomain so that you don't require an extra server path.
  41
  42 3. Create an empty database and note the access details (hostname, username, password, database name).
  43
  44 4. Visit your website with a web browser and follow the instructions.
  45
  46 5. *If* the automated installation fails for any reason, check the following:
  47
  48         5a. ".htconfig.php" exists
  49                 If not, edit htconfig.php and change system settings. Rename
  50 to .htconfig.php
  51         5b. Database is populated.
  52                 If not, import the contents of "database.sql" with phpmyadmin
  53 or mysql command line
  54
  55 6. At this point visit your website again, and register your personal account.
  56 Registration errors should all be recoverable automatically.
  57 If you get any *critical* failure at this point, it generally indicates the
  58 database was not installed correctly. You might wish to move/rename
  59 .htconfig.php to another name and empty (called 'dropping') the database
  60 tables, so that you can start fresh.
  61
  62 7. Set up a cron job or scheduled task to run the poller once every 5-10
  63 minutes to pick up the recent "public" postings of your friends. Example:
  64
  65         cd /base/directory; /path/to/php include/poller.php
  66
  67 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  68
  69 If you are using a Linux server, run "crontab -e" and add a line like the
  70 one shown, substituting for your unique paths and settings:
  71
  72 */5 * * * *     cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  73
  74 You can generally find the location of PHP by executing "which php". If you
  75 have troubles with this section please contact your hosting provider for
  76 assistance. Friendika will not work correctly if you cannot perform this step.
  77