Friendica Communications Platform (please note that this is a clone of the repository at github, issues are handled there) https://friendi.ca
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.

294 lines
12KB

  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.4+.
  29. - PHP *command line* access with register_argc_argv set to true in the
  30. php.ini file [or see 'poormancron' in section 8]
  31. - curl, gd (with at least jpeg support), mysql, mbstring, mcrypt, and openssl extensions
  32. - some form of email server or email gateway such that PHP mail() works
  33. - Mysql 5.5.3+ or an equivalant alternative for MySQL (MariaDB, Percona Server etc.)
  34. - ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
  35. (Windows) [Note: other options are presented in Section 8 of this document]
  36. - Installation into a top-level domain or sub-domain (without a
  37. directory/path component in the URL) is preferred. This is REQUIRED if
  38. you wish to communicate with the Diaspora network.
  39. - For alternative server configurations (such as Nginx server and MariaDB
  40. database engine), refer to the wiki at https://github.com/friendica/friendica/wiki
  41. 2. Unpack the Friendica files into the root of your web server document area.
  42. - If you copy the directory tree to your webserver, make sure
  43. that you also copy .htaccess - as "dot" files are often hidden
  44. and aren't normally copied.
  45. 3. Create an empty database and note the access details (hostname, username,
  46. password, database name).
  47. - Friendica needs the permission to create and delete fields and tables in its own database.
  48. 4. If you know in advance that it will be impossible for the web server to
  49. write or create files in your web directory, create an empty file called
  50. .htconfig.php and make it writable by the web server.
  51. 5. Visit your website with a web browser and follow the instructions. Please
  52. note any error messages and correct these before continuing. If you are using
  53. SSL with a known signature authority (recommended), use the https: link to your
  54. website. If you are using a self-signed cert or no cert, use the http: link.
  55. 6. *If* the automated installation fails for any reason, check the following:
  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. 7. At this point visit your website again, and register your personal account.
  63. Registration errors should all be recoverable automatically.
  64. If you get any *critical* failure at this point, it generally indicates the
  65. database was not installed correctly. You might wish to move/rename
  66. .htconfig.php to another name and empty (called 'dropping') the database
  67. tables, so that you can start fresh.
  68. ****************************************************************************
  69. ****************************************************************************
  70. ******** THIS NEXT STEP IS IMPORTANT!!!! ***********
  71. ****************************************************************************
  72. ****************************************************************************
  73. 8. Set up a cron job or scheduled task to run the poller once every 5-10
  74. minutes to pick up the recent "public" postings of your friends. Example:
  75. cd /base/directory; /path/to/php include/poller.php
  76. Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  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. */10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  80. You can generally find the location of PHP by executing "which php". If you
  81. have troubles with this section please contact your hosting provider for
  82. assistance. Friendica will not work correctly if you cannot perform this step.
  83. You should also be sure that $a->config['php_path'] is set correctly, it should
  84. look like (changing it to the correct PHP location)
  85. $a->config['php_path'] = '/usr/local/php53/bin/php'
  86. Alternative: You may be able to use the 'poormancron' plugin to perform this
  87. step if you are using a recent Friendica release. 'poormancron' may result in
  88. perfomance and memory issues and is only suitable for small sites with one or
  89. two users and a handful of contacts. To do this, edit the file
  90. ".htconfig.php" and look for a line describing your plugins. On a fresh
  91. installation, it will look like
  92. $a->config['system']['addon'] = 'js_upload';
  93. This indicates the "js_upload" addon module is enabled. You may add additional
  94. addons/plugins using this same line in the configuration file. Change it to
  95. read
  96. $a->config['system']['addon'] = 'js_upload,poormancron';
  97. and save your changes.
  98. 9. (Optional) Reverse-proxying and HTTPS
  99. Friendica looks for some well-known HTTP headers indicating a reverse-proxy
  100. terminating an HTTPS connection. While the standard from RFC 7239 specifies
  101. the use of the `Forwaded` header.
  102. Forwarded: for=192.0.2.1; proto=https; by=192.0.2.2
  103. Friendica also supports a number on non-standard headers in common use.
  104. X-Forwarded-Proto: https
  105. Front-End-Https: on
  106. X-Forwarded-Ssl: on
  107. It is however preferable to use the standard approach if configuring a new server.
  108. #####################################################################
  109. If things don't work...
  110. #####################################################################
  111. #####################################################################
  112. - If you get the message
  113. "System is currently unavailable. Please try again later"
  114. #####################################################################
  115. Check your database settings. It usually means your database could not
  116. be opened or accessed. If the database resides on the same machine, check that
  117. the database server name is "localhost".
  118. #####################################################################
  119. - 500 Internal Error
  120. #####################################################################
  121. This could be the result of one of our Apache directives not being
  122. supported by your version of Apache. Examine your apache server logs.
  123. You might remove the line "Options -Indexes" from the .htaccess file if
  124. you are using a Windows server as this has been known to cause problems.
  125. Also check your file permissions. Your website and all contents must generally
  126. be world-readable.
  127. It is likely that your web server reported the source of the problem in
  128. its error log files. Please review these system error logs to determine what
  129. caused the problem. Often this will need to be resolved with your hosting
  130. provider or (if self-hosted) your web server configuration.
  131. #####################################################################
  132. - 400 and 4xx "File not found" errors
  133. #####################################################################
  134. First check your file permissions. Your website and all contents must
  135. generally be world-readable.
  136. Ensure that mod-rewite is installed and working, and that your
  137. .htaccess file is being used. To verify the latter, create a file test.out
  138. containing the word "test" in the top directory of Friendica, make it world
  139. readable and point your web browser to
  140. http://yoursitenamehere.com/test.out
  141. This file should be blocked. You should get a permission denied message.
  142. If you see the word "test" your Apache configuration is not allowing
  143. your .htaccess file to be used (there are rules in this file to block access
  144. to any file with .out at the end, as these are typically used for system logs).
  145. Make certain the .htaccess file exists and is readable by everybody, then
  146. look for the existence of "AllowOverride None" in the Apache server
  147. configuration for your site. This will need to be changed to
  148. "AllowOverride All".
  149. If you do not see the word "test", your .htaccess is working, but it is
  150. likely that mod-rewrite is not installed in your web server or is not working.
  151. On most flavour of Linux,
  152. % a2enmod rewrite
  153. % /etc/init.d/apache2 restart
  154. Consult your hosting provider, experts on your particular Linux
  155. distribution or (if Windows) the provider of your Apache server software if
  156. you need to change either of these and can not figure out how. There is
  157. a lot of help available on the web. Google "mod-rewrite" along with the
  158. name of your operating system distribution or Apache package (if using
  159. Windows).
  160. #####################################################################
  161. - If you are unable to write the file .htconfig.php during installation
  162. due to permissions issues:
  163. #####################################################################
  164. create an empty file with that name and give it world-write permission.
  165. For Linux:
  166. % touch .htconfig.php
  167. % chmod 777 .htconfig.php
  168. Retry the installation. As soon as the database has been created,
  169. ******* this is important *********
  170. % chmod 755 .htconfig.php
  171. #####################################################################
  172. - Some configurations with "suhosin" security are configured without
  173. an ability to run external processes. Friendica requires this ability.
  174. Following are some notes provided by one of our members.
  175. #####################################################################
  176. On my server I use the php protection system Suhosin
  177. [http://www.hardened-php.net/suhosin/]. One of the things it does is to block
  178. certain functions like proc_open, as configured in /etc/php5/conf.d/suhosin.ini:
  179. suhosin.executor.func.blacklist = proc_open, ...
  180. For those sites like Friendica that really need these functions they can be
  181. enabled, e.g. in /etc/apache2/sites-available/friendica:
  182. <Directory /var/www/friendica/>
  183. php_admin_value suhosin.executor.func.blacklist none
  184. php_admin_value suhosin.executor.eval.blacklist none
  185. </Directory>
  186. This enables every function for Friendica if accessed via browser, but not for
  187. the cronjob that is called via php command line. I attempted to enable it for
  188. cron by using something like
  189. */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php
  190. -d suhosin.executor.func.blacklist=none -d suhosin.executor.eval.blacklist=none
  191. -f include/poller.php
  192. This worked well for simple test cases, but the friendica-cron still failed with
  193. a fatal error:
  194. suhosin[22962]: ALERT - function within blacklist called: proc_open() (attacker
  195. 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php', line 1341)
  196. After a while I noticed, that include/poller.php calls further php script via
  197. proc_open. These scripts themselves also use proc_open and fail, because they
  198. are NOT called with -d suhosin.executor.func.blacklist=none.
  199. So the simple solution is to put the correct parameters into .htconfig.php:
  200. // Location of PHP command line processor
  201. $a->config['php_path'] = '/usr/bin/php -d suhosin.executor.func.blacklist=none
  202. -d suhosin.executor.eval.blacklist=none';
  203. This is obvious as soon as you notice that the friendica-cron uses proc_open to
  204. execute php-scripts that also use proc_open, but it took me quite some time to
  205. find that out. I hope this saves some time for other people using suhosin with
  206. function blacklists.