doc/Install.md

   1 Friendica Installation
   2
   3 We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendica 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 Friendica. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation.
   4
   5 Also if you encounter installation issues, please let us know via the forums at http://groups.google.com/group/friendica or file an issue at http://bugs.friendica.com . Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future. Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues.
   6
   7 Before you begin: Choose a domain name or subdomain name for your server. Put some thought into this - because changing it after installation is currently not-supported. Things will break, and some of your friends may have difficulty communicating with you. We plan to address this limitation in a future release.
   8
   9
  10 1. Requirements
  11     - Apache with mod-rewrite enabled and "Options All" so you can use a
  12 local .htaccess file
  13
  14     - PHP  5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3.
  15         - PHP *command line* access with register_argc_argv set to true in the
  16 php.ini file
  17         - curl, gd, mysql, and openssl extensions
  18         - some form of email server or email gateway such that PHP mail() works
  19         - mcrypt (optional; used for server-to-server message encryption)
  20
  21     - Mysql 5.x
  22
  23     - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  24 (Windows) [Note: other options are presented in Section 7 of this document]
  25
  26     - Installation into a top-level domain or sub-domain (without a
  27 directory/path component in the URL) is preferred. Directory paths will
  28 not be as convenient to use and have not been thoroughly tested.
  29
  30
  31     [Dreamhost.com offers all of the necessary hosting features at a
  32 reasonable price. If your hosting provider doesn't allow Unix shell access,
  33 you might have trouble getting everything to work.]
  34
  35 2. Unpack the Friendica files into the root of your web server document area.
  36
  37     - If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file. This makes the software much easier to update. The Linux command to clone the repository into a directory "mywebsite" would be
  38
  39         `git clone https://github.com/friendica/friendica.git mywebsite`
  40
  41     - and then you can pick up the latest changes at any time with
  42
  43         `git pull`
  44
  45     - For installing addons
  46
  47         - First you should be **on** your website folder
  48
  49             `cd mywebsite`
  50
  51         - Then you should clone the addon repository (separtely)
  52
  53             `git clone https://github.com/friendica/friendica-addons.git addon`
  54
  55         - For keeping the addon tree updated, you should be on you addon tree and issue a git pull
  56
  57             `cd mywebsite/addon`
  58
  59             `git pull`
  60
  61     - If you copy the directory tree to your webserver, make sure
  62     that you also copy .htaccess - as "dot" files are often hidden
  63     and aren't normally copied.
  64
  65
  66 3. Create an empty database and note the access details (hostname, username, password, database name).
  67
  68 4. Visit your website with a web browser and follow the instructions. Please note any error messages and correct these before continuing.
  69
  70 5. *If* the automated installation fails for any reason, check the following:
  71
  72     - ".htconfig.php" exists ... If not, edit htconfig.php and change system settings. Rename
  73 to .htconfig.php
  74     - Database is populated. ... If not, import the contents of "database.sql" with phpmyadmin
  75 or mysql command line
  76
  77 6. At this point visit your website again, and register your personal account.
  78 Registration errors should all be recoverable automatically.
  79 If you get any *critical* failure at this point, it generally indicates the
  80 database was not installed correctly. You might wish to move/rename
  81 .htconfig.php to another name and empty (called 'dropping') the database
  82 tables, so that you can start fresh.
  83
  84 7. Set up a cron job or scheduled task to run the poller once every 5-10
  85 minutes in order to perform background processing. Example:
  86
  87     `cd /base/directory; /path/to/php include/poller.php`
  88
  89 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  90
  91 If you are using a Linux server, run "crontab -e" and add a line like the
  92 one shown, substituting for your unique paths and settings:
  93
  94 `*/10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php`
  95
  96 You can generally find the location of PHP by executing "which php". If you
  97 have troubles with this section please contact your hosting provider for
  98 assistance. Friendica will not work correctly if you cannot perform this step.
  99
 100 Alternative: You may be able to use the 'poormancron' plugin to perform this step
 101 if you are using a recent Friendica release. To do this, edit the file ".htconfig.php"
 102 and look for a line describing your plugins. On a fresh installation, it will look like
 103
 104 `$a->config['system']['addon'] = 'js_upload';`
 105
 106 This indicates the "js_upload" addon module is enabled. You may add additional
 107 addons/plugins using this same line in the configuration file. Change it to read
 108
 109 `$a->config['system']['addon'] = 'js_upload,poormancron';`
 110
 111 and save your changes.