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.

219 lines
9.3 KiB

  1. Friendika Installation
  2. We've tried very hard to ensure that Friendika will run on commodity hosting
  3. platforms - such as those used to host Wordpress blogs and Drupal websites.
  4. But be aware that Friendika 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 Friendika.
  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. Friendika will work with self-signed certs
  21. but Diaspora communication may not. For best results, install your cert PRIOR
  22. to installing Friendika 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, 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. 2. Unpack the Friendika files into the root of your web server document area.
  41. - If you copy the directory tree to your webserver, make sure
  42. that you also copy .htaccess - as "dot" files are often hidden
  43. and aren't normally copied.
  44. 3. Create an empty database and note the access details (hostname, username,
  45. password, database name).
  46. 4. If you know in advance that it will be impossible for the web server to
  47. write or create files in your web directory, create an empty file called
  48. .htconfig.php and make it writable by the web server.
  49. 5. Visit your website with a web browser and follow the instructions. Please
  50. note any error messages and correct these before continuing. If you are using
  51. SSL with a known signature authority (recommended), use the https: link to your
  52. website. If you are using a self-signed cert or no cert, use the http: link.
  53. 6. *If* the automated installation fails for any reason, check the following:
  54. - ".htconfig.php" exists
  55. If not, edit htconfig.php and change system settings. Rename
  56. to .htconfig.php
  57. - Database is populated.
  58. If not, import the contents of "database.sql" with phpmyadmin
  59. or mysql command line
  60. 7. At this point visit your website again, and register your personal account.
  61. Registration errors should all be recoverable automatically.
  62. If you get any *critical* failure at this point, it generally indicates the
  63. database was not installed correctly. You might wish to move/rename
  64. .htconfig.php to another name and empty (called 'dropping') the database
  65. tables, so that you can start fresh.
  66. ****************************************************************************
  67. ****************************************************************************
  68. ******** THIS NEXT STEP IS IMPORTANT!!!! ***********
  69. ****************************************************************************
  70. ****************************************************************************
  71. 8. Set up a cron job or scheduled task to run the poller once every 5-10
  72. minutes to pick up the recent "public" postings of your friends. Example:
  73. cd /base/directory; /path/to/php include/poller.php
  74. Change "/base/directory", and "/path/to/php" as appropriate for your situation.
  75. If you are using a Linux server, run "crontab -e" and add a line like the
  76. one shown, substituting for your unique paths and settings:
  77. */10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
  78. You can generally find the location of PHP by executing "which php". If you
  79. have troubles with this section please contact your hosting provider for
  80. assistance. Friendika will not work correctly if you cannot perform this step.
  81. Alternative: You may be able to use the 'poormancron' plugin to perform this
  82. step if you are using a recent Friendika release. 'poormancron' may result in
  83. perfomance and memory issues and is only suitable for small sites with one or
  84. two users and a handful of contacts. To do this, edit the file
  85. ".htconfig.php" and look for a line describing your plugins. On a fresh
  86. installation, it will look like
  87. $a->config['system']['addon'] = 'js_upload';
  88. This indicates the "js_upload" addon module is enabled. You may add additional
  89. addons/plugins using this same line in the configuration file. Change it to
  90. read
  91. $a->config['system']['addon'] = 'js_upload,poormancron';
  92. and save your changes.
  93. #####################################################################
  94. If things don't work...
  95. #####################################################################
  96. #####################################################################
  97. - If you get the message
  98. "System is currently unavailable. Please try again later"
  99. #####################################################################
  100. Check your database settings. It usually means your database could not
  101. be opened or accessed. If the database resides on the same machine, check that
  102. the database server name is "localhost".
  103. #####################################################################
  104. - 500 Internal Error
  105. #####################################################################
  106. This could be the result of one of our Apache directives not being
  107. supported by your version of Apache. Examine your apache server logs.
  108. You might remove the line "Options -Indexes" from the .htaccess file if
  109. you are using a Windows server as this has been known to cause problems.
  110. Also check your file permissions. Your website and all contents must generally
  111. be world-readable.
  112. It is likely that your web server reported the source of the problem in
  113. its error log files. Please review these system error logs to determine what
  114. caused the problem. Often this will need to be resolved with your hosting
  115. provider or (if self-hosted) your web server configuration.
  116. #####################################################################
  117. - 400 and 4xx "File not found" errors
  118. #####################################################################
  119. First check your file permissions. Your website and all contents must
  120. generally be world-readable.
  121. Ensure that mod-rewite is installed and working, and that your
  122. .htaccess file is being used. To verify the latter, create a file test.out
  123. containing the word "test" in the top directory of Friendika, make it world
  124. readable and point your web browser to
  125. http://yoursitenamehere.com/test.out
  126. This file should be blocked. You should get a permission denied message.
  127. If you see the word "test" your Apache configuration is not allowing
  128. your .htaccess file to be used (there are rules in this file to block access
  129. to any file with .out at the end, as these are typically used for system logs).
  130. Make certain the .htaccess file exists and is readable by everybody, then
  131. look for the existence of "AllowOverride None" in the Apache server
  132. configuration for your site. This will need to be changed to
  133. "AllowOverride All".
  134. If you do not see the word "test", your .htaccess is working, but it is
  135. likely that mod-rewrite is not installed in your web server or is not working.
  136. On most flavour of Linux,
  137. % a2enmod rewrite
  138. % /etc/init.d/apache2 restart
  139. Consult your hosting provider, experts on your particular Linux
  140. distribution or (if Windows) the provider of your Apache server software if
  141. you need to change either of these and can not figure out how. There is
  142. a lot of help available on the web. Google "mod-rewrite" along with the
  143. name of your operating system distribution or Apache package (if using
  144. Windows).
  145. #####################################################################
  146. - If you are unable to write the file .htconfig.php during installation
  147. due to permissions issues:
  148. #####################################################################
  149. create an empty file with that name and give it world-write permission.
  150. For Linux:
  151. % touch .htconfig.php
  152. % chmod 777 .htconfig.php
  153. Retry the installation. As soon as the database has been created,
  154. ******* this is important *********
  155. % chmod 755 .htconfig.php