Friendica Communications Platform (please note that this is a clone of the repository at github, issues are handled there)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

INSTALL.txt 12KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277
  1. Friendica Installation
  2. We've tried very hard to ensure that Friendica will run on commodity hosting
  3. platforms - such as those used to host Wordpress blogs and Drupal websites.
  4. But be aware that Friendica is more than a simple web application. It is a
  5. complex communications system which more closely resembles an email server
  6. than a web server. For reliability and performance, messages are delivered in
  7. the background and are queued for later delivery when sites are down. This
  8. kind of functionality requires a bit more of the host system than the typical
  9. blog. Not every PHP/MySQL hosting provider will be able to support Friendica.
  10. Many will. But please review the requirements and confirm these with your
  11. hosting provider prior to installation.
  12. Before you begin: Choose a domain name or subdomain name for your server.
  13. Put some thought into this - because changing it is currently not-supported.
  14. Things will break, and some of your friends may have difficulty communicating
  15. with you. We plan to address this limitation in a future release. Also decide
  16. if you wish to connect with members of the Diaspora network, as this will
  17. impact the installation requirements.
  18. Decide if you will use SSL and obtain an SSL cert. Communications with the
  19. Diaspora network MAY require both SSL AND an SSL cert signed by a CA which is
  20. recognised by the major browsers. Friendica will work with self-signed certs
  21. but Diaspora communication may not. For best results, install your cert PRIOR
  22. to installing Friendica and when visiting your site for the initial
  23. installation in step 5, please use the https: link. (Use the http: or non-SSL
  24. link if your cert is self-signed).
  25. 1. Requirements
  26. - Apache with mod-rewrite enabled and "Options All" so you can use a
  27. local .htaccess file
  28. - PHP 5.2+. The later the better. PHP 5.3 is required for communications
  29. with the Diaspora network and improved security.
  30. - PHP *command line* access with register_argc_argv set to true in the
  31. php.ini file [or see 'poormancron' in section 8]
  32. - curl, gd (with at least jpeg support), mysql, mbstring, mcrypt, and openssl extensions
  33. - some form of email server or email gateway such that PHP mail() works
  34. - Mysql 5.x
  35. - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  36. (Windows) [Note: other options are presented in Section 8 of this document]
  37. - Installation into a top-level domain or sub-domain (without a
  38. directory/path component in the URL) is preferred. This is REQUIRED if
  39. you wish to communicate with the Diaspora network.
  40. - For alternative server configurations (such as Nginx server and MariaDB
  41. database engine), refer to the wiki at https://github.com/friendica/friendica/wiki
  42. 2. Unpack the Friendica files into the root of your web server document area.
  43. - If you copy the directory tree to your webserver, make sure
  44. that you also copy .htaccess - as "dot" files are often hidden
  45. and aren't normally copied.
  46. 3. Create an empty database and note the access details (hostname, username,
  47. password, database name).
  48. - Friendica needs the permission to create and delete fields and tables in its own database.
  49. 4. If you know in advance that it will be impossible for the web server to
  50. write or create files in your web directory, create an empty file called
  51. .htconfig.php and make it writable by the web server.
  52. 5. Visit your website with a web browser and follow the instructions. Please
  53. note any error messages and correct these before continuing. If you are using
  54. SSL with a known signature authority (recommended), use the https: link to your
  55. website. If you are using a self-signed cert or no cert, use the http: link.
  56. 6. *If* the automated installation fails for any reason, check the following:
  57. - ".htconfig.php" exists
  58. If not, edit htconfig.php and change system settings. Rename
  59. to .htconfig.php
  60. - Database is populated.
  61. If not, import the contents of "database.sql" with phpmyadmin
  62. or mysql command line
  63. 7. 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. ****************************************************************************
  71. ******** THIS NEXT STEP IS IMPORTANT!!!! ***********
  72. ****************************************************************************
  73. ****************************************************************************
  74. 8. Set up a cron job or scheduled task to run the poller once every 5-10
  75. minutes to pick up the recent "public" postings of your friends. Example:
  76. cd /base/directory; /path/to/php include/poller.php
  77. Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  78. If you are using a Linux server, run "crontab -e" and add a line like the
  79. one shown, substituting for your unique paths and settings:
  80. */10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  81. You can generally find the location of PHP by executing "which php". If you
  82. have troubles with this section please contact your hosting provider for
  83. assistance. Friendica will not work correctly if you cannot perform this step.
  84. You should also be sure that $a->config['php_path'] is set correctly, it should
  85. look like (changing it to the correct PHP location)
  86. $a->config['php_path'] = '/usr/local/php53/bin/php'
  87. Alternative: You may be able to use the 'poormancron' plugin to perform this
  88. step if you are using a recent Friendica release. 'poormancron' may result in
  89. perfomance and memory issues and is only suitable for small sites with one or
  90. two users and a handful of contacts. To do this, edit the file
  91. ".htconfig.php" and look for a line describing your plugins. On a fresh
  92. installation, it will look like
  93. $a->config['system']['addon'] = 'js_upload';
  94. This indicates the "js_upload" addon module is enabled. You may add additional
  95. addons/plugins using this same line in the configuration file. Change it to
  96. read
  97. $a->config['system']['addon'] = 'js_upload,poormancron';
  98. and save your changes.
  99. #####################################################################
  100. If things don't work...
  101. #####################################################################
  102. #####################################################################
  103. - If you get the message
  104. "System is currently unavailable. Please try again later"
  105. #####################################################################
  106. Check your database settings. It usually means your database could not
  107. be opened or accessed. If the database resides on the same machine, check that
  108. the database server name is "localhost".
  109. #####################################################################
  110. - 500 Internal Error
  111. #####################################################################
  112. This could be the result of one of our Apache directives not being
  113. supported by your version of Apache. Examine your apache server logs.
  114. You might remove the line "Options -Indexes" from the .htaccess file if
  115. you are using a Windows server as this has been known to cause problems.
  116. Also check your file permissions. Your website and all contents must generally
  117. be world-readable.
  118. It is likely that your web server reported the source of the problem in
  119. its error log files. Please review these system error logs to determine what
  120. caused the problem. Often this will need to be resolved with your hosting
  121. provider or (if self-hosted) your web server configuration.
  122. #####################################################################
  123. - 400 and 4xx "File not found" errors
  124. #####################################################################
  125. First check your file permissions. Your website and all contents must
  126. generally be world-readable.
  127. Ensure that mod-rewite is installed and working, and that your
  128. .htaccess file is being used. To verify the latter, create a file test.out
  129. containing the word "test" in the top directory of Friendica, make it world
  130. readable and point your web browser to
  131. http://yoursitenamehere.com/test.out
  132. This file should be blocked. You should get a permission denied message.
  133. If you see the word "test" your Apache configuration is not allowing
  134. your .htaccess file to be used (there are rules in this file to block access
  135. to any file with .out at the end, as these are typically used for system logs).
  136. Make certain the .htaccess file exists and is readable by everybody, then
  137. look for the existence of "AllowOverride None" in the Apache server
  138. configuration for your site. This will need to be changed to
  139. "AllowOverride All".
  140. If you do not see the word "test", your .htaccess is working, but it is
  141. likely that mod-rewrite is not installed in your web server or is not working.
  142. On most flavour of Linux,
  143. % a2enmod rewrite
  144. % /etc/init.d/apache2 restart
  145. Consult your hosting provider, experts on your particular Linux
  146. distribution or (if Windows) the provider of your Apache server software if
  147. you need to change either of these and can not figure out how. There is
  148. a lot of help available on the web. Google "mod-rewrite" along with the
  149. name of your operating system distribution or Apache package (if using
  150. Windows).
  151. #####################################################################
  152. - If you are unable to write the file .htconfig.php during installation
  153. due to permissions issues:
  154. #####################################################################
  155. create an empty file with that name and give it world-write permission.
  156. For Linux:
  157. % touch .htconfig.php
  158. % chmod 777 .htconfig.php
  159. Retry the installation. As soon as the database has been created,
  160. ******* this is important *********
  161. % chmod 755 .htconfig.php
  162. #####################################################################
  163. - Some configurations with "suhosin" security are configured without
  164. an ability to run external processes. Friendica requires this ability.
  165. Following are some notes provided by one of our members.
  166. #####################################################################
  167. On my server I use the php protection system Suhosin
  168. [http://www.hardened-php.net/suhosin/]. One of the things it does is to block
  169. certain functions like proc_open, as configured in /etc/php5/conf.d/suhosin.ini:
  170. suhosin.executor.func.blacklist = proc_open, ...
  171. For those sites like Friendica that really need these functions they can be
  172. enabled, e.g. in /etc/apache2/sites-available/friendica:
  173. <Directory /var/www/friendica/>
  174. php_admin_value suhosin.executor.func.blacklist none
  175. php_admin_value suhosin.executor.eval.blacklist none
  176. </Directory>
  177. This enables every function for Friendica if accessed via browser, but not for
  178. the cronjob that is called via php command line. I attempted to enable it for
  179. cron by using something like
  180. */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php
  181. -d suhosin.executor.func.blacklist=none -d suhosin.executor.eval.blacklist=none
  182. -f include/poller.php
  183. This worked well for simple test cases, but the friendica-cron still failed with
  184. a fatal error:
  185. suhosin[22962]: ALERT - function within blacklist called: proc_open() (attacker
  186. 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php', line 1341)
  187. After a while I noticed, that include/poller.php calls further php script via
  188. proc_open. These scripts themselves also use proc_open and fail, because they
  189. are NOT called with -d suhosin.executor.func.blacklist=none.
  190. So the simple solution is to put the correct parameters into .htconfig.php:
  191. // Location of PHP command line processor
  192. $a->config['php_path'] = '/usr/bin/php -d suhosin.executor.func.blacklist=none
  193. -d suhosin.executor.eval.blacklist=none';
  194. This is obvious as soon as you notice that the friendica-cron uses proc_open to
  195. execute php-scripts that also use proc_open, but it took me quite some time to
  196. find that out. I hope this saves some time for other people using suhosin with
  197. function blacklists.