doc/Install.md

   1 Friendica Installation
   2 ===============
   3
   4 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.
   5 But be aware that Friendica is more than a simple web application.
   6 It is a complex communications system which more closely resembles an email server than a web server.
   7 For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
   8 This kind of functionality requires a bit more of the host system than the typical blog.
   9 Not every PHP/MySQL hosting provider will be able to support Friendica.
  10 Many will.
  11 But **please** review the requirements and confirm these with your hosting provider prior to installation.
  12
  13 Also if you encounter installation issues, please let us know via the [helper]() or the [developer]() forum or [file an issue](https://github.com/friendica/friendica/issues).
  14 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.
  15 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.
  16
  17 Before you begin: Choose a domain name or subdomain name for your server.
  18 Put some thought into this. Changing it after installation is currently not supported.
  19 Things will break, and some of your friends may have difficulty communicating with you.
  20 We plan to address this limitation in a future release.
  21
  22
  23 Requirements
  24 ---
  25
  26 * Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
  27 * 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.
  28 * PHP *command line* access with register_argc_argv set to true in the php.ini file
  29 * curl, gd, mysql, hash and openssl extensions
  30 * some form of email server or email gateway such that PHP mail() works
  31 * mcrypt (optional; used for server-to-server message encryption)
  32 * Mysql 5.x
  33 * the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 of this document.)
  34 * 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.
  35 * If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
  36
  37 Installation procedure
  38 ---
  39
  40 ###Get Friendica
  41
  42 Unpack the Friendica files into the root of your web server document area.
  43 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.
  44 This makes the software much easier to update.
  45 The Linux command to clone the repository into a directory "mywebsite" would be
  46
  47         git clone https://github.com/friendica/friendica.git mywebsite
  48
  49 Make sure the folder *view/smarty3* exists and is writable by the webserver user
  50
  51         mkdir view/smarty3
  52         chmod 777 view/smarty3
  53
  54 Get the addons by going into your website folder.
  55
  56         cd mywebsite
  57
  58 Clone the addon repository (separately):
  59
  60         git clone https://github.com/friendica/friendica-addons.git addon
  61
  62 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.
  63
  64 ###Create a database
  65
  66 Create an empty database and note the access details (hostname, username, password, database name).
  67
  68 ###Run the installer
  69
  70 Point your web browser to the new site and follow the instructions.
  71 Please note any error messages and correct these before continuing.
  72
  73 *If* the automated installation fails for any reason, check the following:
  74
  75 * Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php
  76 * Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or mysql command line.
  77
  78 At this point visit your website again, and register your personal account.
  79 Registration errors should all be recoverable automatically.
  80 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
  81 You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh.
  82
  83 ###Set up the poller
  84
  85 Set up a cron job or scheduled task to run the poller once every 5-10 minutes in order to perform background processing.
  86 Example:
  87
  88         cd /base/directory; /path/to/php include/poller.php
  89
  90 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  91
  92 If you are using a Linux server, run "crontab -e" and add a line like the
  93 one shown, substituting for your unique paths and settings:
  94
  95         */10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  96
  97 You can generally find the location of PHP by executing "which php".
  98 If you run into trouble with this section please contact your hosting provider for assistance.
  99 Friendica will not work correctly if you cannot perform this step.
 100
 101 Alternative: You may be able to use the 'poormancron' plugin to perform this step.
 102 To do this, edit the file ".htconfig.php" and look for a line describing your plugins.
 103 On a fresh installation, it will look like this:
 104
 105         $a->config['system']['addon'] = 'js_upload';
 106
 107 It indicates the "js_upload" addon module is enabled.
 108 You may add additional addons/plugins using this same line in the configuration file.
 109 Change it to read
 110
 111         $a->config['system']['addon'] = 'js_upload,poormancron';
 112
 113 and save your changes.
 114
 115 Updating your installation with git
 116 ---
 117
 118 You can get the latest changes at any time with
 119
 120         cd mywebsite
 121         git pull
 122
 123 The addon tree has to be updated separately like so:
 124
 125         cd mywebsite/addon
 126         git pull