INSTALL.txt

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