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 We offer a manual and an automatic installation.
   6 But be aware that Friendica is more than a simple web application.
   7
   8 It is a complex communications system which more closely resembles an email server than a web server.
   9 For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
  10 This kind of functionality requires a bit more of the host system than the typical blog.
  11
  12 Not every PHP/MySQL hosting provider will be able to support Friendica.
  13 Many will.
  14
  15 But **please** review the [requirements](#Requirements) and confirm these with your hosting provider prior to installation.
  16
  17 ## Support
  18 If you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) forum or [file an issue](https://github.com/friendica/friendica/issues).
  19
  20 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.
  21 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.
  22
  23 ## Prerequisites
  24
  25 * Choose a domain name or subdomain name for your server. Put some thought into this. While changing it after installation is supported, things still might break.
  26 * Setup HTTPS on your domain.
  27
  28 ### Requirements
  29
  30 * Apache with mod-rewrite enabled and "Options All" so you can use a local `.htaccess` file
  31 * PHP 7.2+ (PHP8 is not fully supported yet)
  32   * PHP *command line* access with register_argc_argv set to true in the php.ini file
  33   * Curl, GD, PDO, mbstrings, MySQLi, hash, xml, zip and OpenSSL extensions
  34   * The POSIX module of PHP needs to be activated (e.g. [RHEL, CentOS](http://www.bigsoft.co.uk/blog/index.php/2014/12/08/posix-php-commands-not-working-under-centos-7) have disabled it)
  35   * some form of email server or email gateway such that PHP mail() works
  36 * MySQL 5.6+ or an equivalent alternative for MySQL (MariaDB, Percona Server etc.)
  37 * ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows)
  38 * installation into a top-level domain or sub-domain (without a directory/path component in the URL) is RECOMMENDED. Directory paths will not be as convenient to use and have not been thoroughly tested. This is REQUIRED if you wish to communicate with the Diaspora network.
  39
  40 **If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.**
  41
  42 For alternative server configurations (such as Nginx server and MariaDB database engine), refer to the [Friendica wiki](https://github.com/friendica/friendica/wiki).
  43
  44 ### Optional
  45
  46 * PHP ImageMagick extension (php-imagick) for animated GIF support.
  47
  48 ## Installation procedure
  49
  50 ### Alternative Installation Methods
  51
  52 This guide will walk you through the manual installation process of Friendica.
  53 If this is nothing for you, you might be interested in
  54
  55 * the [Friendica Docker image](https://github.com/friendica/docker) or
  56 * how to [install Friendica with YunoHost](https://github.com/YunoHost-Apps/friendica_ynh).
  57
  58 ### Get Friendica
  59
  60 Download the full archive of the stable release of Friendica core and the addons from [the project homepage](https://friendi.ca/resources/download-files/).
  61 Make sure that the version of the Friendica archive and the addons match.
  62 Unpack the Friendica files into the root of your web server document area.
  63
  64 If you copy the directory tree to your webserver, make sure that you also copy `.htaccess-dist` - as "dot" files are often hidden and aren't normally copied.
  65
  66 **OR**
  67
  68 Clone the [friendica/friendica GitHub repository](https://github.com/friendica/friendica) and import dependencies.
  69 This makes the software much easier to update.
  70
  71 The Linux commands to clone the repository into a directory "mywebsite" would be
  72
  73     git clone https://github.com/friendica/friendica.git -b stable mywebsite
  74     cd mywebsite
  75     bin/composer.phar install --no-dev
  76
  77 Make sure the folder *view/smarty3* exists and is writable by the webserver user, in this case *www-data*
  78
  79     mkdir -p view/smarty3
  80     chown www-data:www-data view/smarty3
  81     chmod 775 view/smarty3
  82
  83 Get the addons by going into your website folder.
  84
  85     cd mywebsite
  86
  87 Clone the addon repository (separately):
  88
  89     git clone https://github.com/friendica/friendica-addons.git -b stable addon
  90
  91 If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
  92
  93     git checkout develop
  94     bin/composer.phar install
  95     cd addon
  96     git checkout develop
  97
  98 **Be aware that the develop branch is unstable and may break your Friendica node at any time.**
  99 You should have a recent backup before updating.
 100 If you encounter a bug, please let us know.
 101
 102 ### Create a database
 103
 104 Create an empty database and note the access details (hostname, username, password, database name).
 105
 106 Friendica needs the permission to create and delete fields and tables in its own database.
 107
 108 Please check the [troubleshooting](#Troubleshooting) section if running on MySQL 5.7.17 or newer.
 109
 110 ### Option A: Run the installer
 111
 112 Before you point your web browser to the new site you need to copy `.htaccess-dist` to `.htaccess` for Apache installs.
 113 Follow the instructions.
 114 Please note any error messages and correct these before continuing.
 115
 116 If you need to specify a port for the connection to the database, you can do so in the host name setting for the database.
 117
 118 *If* the manual installation fails for any reason, check the following:
 119
 120 * Does `config/local.config.php` exist? If not, edit `config/local-sample.config.php` and change the system settings.
 121 * Rename to `config/local.config.php`.
 122 * Is the database populated? If not, import the contents of `database.sql` with phpmyadmin or the mysql command line.
 123
 124 At this point visit your website again, and register your personal account.
 125 Registration errors should all be recoverable automatically.
 126 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
 127 You might wish to move/rename `config/local.config.php` to another name and empty (called 'dropping') the database tables, so that you can start fresh.
 128
 129 ### Option B: Run the automatic install script
 130
 131 You have the following options to automatically install Friendica:
 132 -       creating a prepared config file (f.e. `prepared.config.php`)
 133 -       using environment variables (f.e. `MYSQL_HOST`)
 134 -       using options (f.e. `--dbhost <host>`)
 135
 136 You can combine environment variables and options, but be aware that options are prioritized over environment variables.
 137
 138 For more information during the installation, you can use this command line option
 139
 140     bin/console autoinstall -v
 141
 142 If you wish to include all optional checks, use `-a` like this statement:
 143
 144     bin/console autoinstall -a
 145
 146 *If* the automatic installation fails for any reason, check the following:
 147
 148 *       Does `config/local.config.php` already exist? If yes, the automatic installation won't start
 149 *       Are the options in the `config/local.config.php` correct? If not, edit them directly.
 150 *       Is the empty MySQL-database created? If not, create it.
 151
 152 #### B.1: Config file
 153
 154 You can use a prepared config file like [local-sample.config.php](/config/local-sample.config.php).
 155
 156 Navigate to the main Friendica directory and execute the following command:
 157
 158     bin/console autoinstall -f <prepared.config.php>
 159
 160 #### B.2: Environment variables
 161
 162 There are two types of environment variables.
 163 -       those you can use in normal mode too (Currently just **database credentials**)
 164 -       those you can only use during installation (because Friendica will normally ignore it)
 165
 166 You can use the options during installation too and skip some of the environment variables.
 167
 168 **Database credentials**
 169
 170 if you don't use the option `--savedb` during installation, the DB credentials will **not** be saved in the `config/local.config.php`.
 171
 172 -       `MYSQL_HOST` The host of the mysql/mariadb database
 173 -       `MYSQL_PORT` The port of the mysql/mariadb database
 174 -       `MYSQL_USERNAME` The username of the mysql database login (used for mysql)
 175 -       `MYSQL_USER` The username of the mysql database login (used for mariadb)
 176 -       `MYSQL_PASSWORD` The password of the mysql/mariadb database login
 177 -       `MYSQL_DATABASE` The name of the mysql/mariadb database
 178
 179 **Friendica settings**
 180
 181 This variables wont be used at normal Friendica runtime.
 182 Instead, they get saved into `config/local.config.php`.
 183
 184 -       `FRIENDICA_URL_PATH` The URL path of Friendica (f.e. '/friendica')
 185 -       `FRIENDICA_PHP_PATH` The path of the PHP binary
 186 -       `FRIENDICA_ADMIN_MAIL` The admin email address of Friendica (this email will be used for admin access)
 187 -       `FRIENDICA_TZ` The timezone of Friendica
 188 -       `FRIENDICA_LANG` The language of Friendica
 189
 190 Navigate to the main Friendica directory and execute the following command:
 191
 192     bin/console autoinstall [--savedb]
 193
 194 #### B.3: Execution options
 195
 196 All options will be saved in the `config/local.config.php` and are overruling the associated environment variables.
 197
 198 -       `-H|--dbhost <host>` The host of the mysql/mariadb database (env `MYSQL_HOST`)
 199 -       `-p|--dbport <port>` The port of the mysql/mariadb database (env `MYSQL_PORT`)
 200 -       `-U|--dbuser <username>` The username of the mysql/mariadb database login (env `MYSQL_USER` or `MYSQL_USERNAME`)
 201 -       `-P|--dbpass <password>` The password of the mysql/mariadb database login (env `MYSQL_PASSWORD`)
 202 -       `-d|--dbdata <database>` The name of the mysql/mariadb database (env `MYSQL_DATABASE`)
 203 -       `-u|--urlpath <url_path>` The URL path of Friendica - f.e. '/friendica' (env `FRIENDICA_URL_PATH`)
 204 -       `-b|--phppath <php_path>` The path of the PHP binary (env `FRIENDICA_PHP_PATH`)
 205 -       `-A|--admin <mail>` The admin email address of Friendica (env `FRIENDICA_ADMIN_MAIL`)
 206 -       `-T|--tz <timezone>` The timezone of Friendica (env `FRIENDICA_TZ`)
 207 -       `-L|--lang <language>` The language of Friendica (env `FRIENDICA_LANG`)
 208
 209 Navigate to the main Friendica directory and execute the following command:
 210
 211     bin/console autoinstall [options]
 212
 213 ### Prepare .htaccess file
 214
 215 Copy `.htaccess-dist` to `.htaccess` (be careful under Windows) to have working mod-rewrite again. If you have installed Friendica into a sub directory, like */friendica/* set this path in `RewriteBase` accordingly.
 216
 217 Example:
 218
 219     cp .htacces-dist .htaccess
 220
 221 *Note*: Do **not** rename the `.htaccess-dist` file as it is tracked by GIT and renaming will cause a dirty working directory.
 222
 223 ### Verify the "host-meta" page is working
 224
 225 Friendica should respond automatically to important addresses under the */.well-known/* rewrite path.
 226 One critical URL would look like, for example: https://example.com/.well-known/host-meta
 227 It must be visible to the public and must respond with an XML file that is automatically customized to your site.
 228
 229 If that URL is not working, it is possible that some other software is using the /.well-known/ path.
 230 Other symptoms may include an error message in the Admin settings that says "host-meta is not reachable on your system.
 231 This is a severe configuration issue that prevents server to server communication."
 232 Another common error related to host-meta is the "Invalid profile URL."
 233
 234 Check for a `.well-known` directory that did not come with Friendica.
 235 The preferred configuration is to remove the directory, however this is not always possible.
 236 If there is any /.well-known/.htaccess file, it could interfere with this Friendica core requirement.
 237 You should remove any RewriteRules from that file, or remove that whole file if appropriate.
 238 It may be necessary to chmod the /.well-known/.htaccess file if you were not given write permissions by default.
 239
 240 ## Register the admin account
 241
 242 At this point visit your website again, and register your personal account with the same email as in the `config.admin_email` config value.
 243 Registration errors should all be recoverable automatically.
 244
 245 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
 246 You might wish to delete/rename `config/local.config.php` to another name and drop all the database tables so that you can start fresh.
 247
 248 ## Post Install Configuration
 249
 250 ### (REQUIRED) Background tasks
 251
 252 Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing.
 253 Example:
 254
 255     cd /base/directory; /path/to/php bin/worker.php
 256
 257 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
 258
 259 #### cron job for worker
 260
 261 If you are using a Linux server, run "crontab -e" and add a line like the
 262 one shown, substituting for your unique paths and settings:
 263
 264     */10 * * * * cd /home/myname/mywebsite; /usr/bin/php bin/worker.php
 265
 266 You can generally find the location of PHP by executing "which php".
 267 If you run into trouble with this section please contact your hosting provider for assistance.
 268 Friendica will not work correctly if you cannot perform this step.
 269
 270 If it is not possible to set up a cron job then please activate the "frontend worker" in the administration interface.
 271
 272 Once you have installed Friendica and created an admin account as part of the process, you can access the admin panel of your installation and do most of the server wide configuration from there.
 273
 274 #### worker alternative: daemon
 275 Otherwise, you’ll need to use the command line on your remote server and start the Friendica daemon (background task) using the following command:
 276
 277     cd /path/to/friendica; php bin/daemon.php start
 278
 279 Once started, you can check the daemon status using the following command:
 280
 281     cd /path/to/friendica; php bin/daemon.php status
 282
 283 After a server restart or any other failure, the daemon needs to be restarted.
 284 This could be achieved by a cronjob.
 285
 286 ### (RECOMMENDED) Logging & Log Rotation
 287
 288 At this point it is recommended that you set up logging and logrotation.
 289 To do so please visit [Settings](help/Settings) and search the 'Logs' section for more information.
 290
 291 ### (RECOMMENDED) Set up a backup plan
 292
 293 Bad things will happen.
 294 Let there be a hardware failure, a corrupted database or whatever you can think of.
 295 So once the installation of your Friendica node is done, you should make yourself a backup plan.
 296
 297 The most important file is the `config/local.config.php` file.
 298 As it stores all your data, you should also have a recent dump of your Friendica database at hand, should you have to recover your node.
 299
 300 ### (OPTIONAL) Reverse-proxying and HTTPS
 301
 302 Friendica looks for some well-known HTTP headers indicating a reverse-proxy
 303 terminating an HTTPS connection.
 304 While the standard from RFC 7239 specifies the use of the `Forwarded` header.
 305
 306     Forwarded: for=192.0.2.1; proto=https; by=192.0.2.2
 307
 308 Friendica also supports a number on non-standard headers in common use.
 309
 310     X-Forwarded-Proto: https
 311
 312     Front-End-Https: on
 313
 314     X-Forwarded-Ssl: on
 315
 316 It is however preferable to use the standard approach if configuring a new server.
 317
 318 ## Troubleshooting
 319
 320 ### "System is currently unavailable. Please try again later"
 321
 322 Check your database settings.
 323 It usually means your database could not be opened or accessed.
 324 If the database resides on the same machine, check that the database server name is "localhost".
 325
 326 ### 500 Internal Error
 327
 328 This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.
 329 You might remove the line "Options -Indexes" from the `.htaccess` file if you are using a Windows server as this has been known to cause problems.
 330 Also check your file permissions. Your website and all contents must generally be world-readable.
 331
 332 It is likely that your web server reported the source of the problem in its error log files.
 333 Please review these system error logs to determine what caused the problem.
 334 Often this will need to be resolved with your hosting provider or (if self-hosted) your web server configuration.
 335
 336 ### 400 and 4xx "File not found" errors
 337
 338 First check your file permissions.
 339 Your website and all contents must generally be world-readable.
 340
 341 Ensure that mod-rewite is installed and working, and that your `.htaccess` file
 342 is being used. To verify the latter, create a file `test.out` containing the
 343 word "test" in the top directory of Friendica, make it world readable and point
 344 your web browser to
 345
 346         http://yoursitenamehere.com/test.out
 347
 348 This file should be blocked. You should get a permission denied message.
 349
 350 If you see the word "test" your Apache configuration is not allowing your
 351 `.htaccess` file to be used (there are rules in this file to block access to any
 352 file with .out at the end, as these are typically used for system logs).
 353
 354 Make certain the `.htaccess` file exists and is readable by everybody, then look
 355 for the existence of "AllowOverride None" in the Apache server configuration for your site.
 356 This will need to be changed to "AllowOverride All".
 357
 358 If you do not see the word "test", your `.htaccess` is working, but it is likely
 359 that mod-rewrite is not installed in your web server or is not working.
 360
 361 On most Linux flavors:
 362
 363         % a2enmod rewrite
 364         % /etc/init.d/apache2 restart
 365
 366 Consult your hosting provider, experts on your particular Linux distribution or
 367 (if Windows) the provider of your Apache server software if you need to change
 368 either of these and can not figure out how. There is a lot of help available on
 369 the web. Search "mod-rewrite" along with the name of your operating system
 370 distribution or Apache package (if using Windows).
 371
 372 ### Unable to write the file config/local.config.php due to permissions issues
 373
 374 Create an empty `config/local.config.php`file and apply world-write permission.
 375
 376 On Linux:
 377
 378         % touch config/local.config.php
 379         % chmod 664 config/local.config.php
 380
 381 Retry the installation. As soon as the database has been created,
 382
 383 ******* this is important *********
 384
 385         % chmod 644 config/local.config.php
 386
 387 ### Suhosin issues
 388
 389 Some configurations with "suhosin" security are configured without an ability to
 390 run external processes. Friendica requires this ability. Following are some notes
 391 provided by one of our members.
 392
 393 > On my server I use the php protection system Suhosin [http://www.hardened-php.net/suhosin/].
 394 > One of the things it does is to block certain functions like proc_open, as
 395 > configured in `/etc/php5/conf.d/suhosin.ini`:
 396 >
 397 >     suhosin.executor.func.blacklist = proc_open, ...
 398 >
 399 > For those sites like Friendica that really need these functions they can be
 400 > enabled, e.g. in `/etc/apache2/sites-available/friendica`:
 401 >
 402 >       <Directory /var/www/friendica/>
 403 >         php_admin_value suhosin.executor.func.blacklist none
 404 >         php_admin_value suhosin.executor.eval.blacklist none
 405 >       </Directory>
 406 >
 407 > This enables every function for Friendica if accessed via browser, but not for
 408 > the cronjob that is called via php command line. I attempted to enable it for
 409 > cron by using something like:
 410 >
 411 >       */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php \
 412 >       -d suhosin.executor.func.blacklist=none \
 413 >       -d suhosin.executor.eval.blacklist=none -f bin/worker.php
 414 >
 415 > This worked well for simple test cases, but the friendica-cron still failed
 416 > with a fatal error:
 417 >
 418 >       suhosin[22962]: ALERT - function within blacklist called: proc_open()
 419 >     (attacker 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php',
 420 >     line 1341)
 421 >
 422 > After a while I noticed, that `bin/worker.php` calls further PHP script via `proc_open`.
 423 > These scripts themselves also use `proc_open` and fail, because they are NOT
 424 > called with `-d suhosin.executor.func.blacklist=none`.
 425 >
 426 >  So the simple solution is to put the correct parameters into `config/local.config.php`:
 427 >
 428 >       'config' => [
 429 >               //Location of PHP command line processor
 430 >               'php_path' => '/usr/bin/php -d suhosin.executor.func.blacklist=none \
 431 >               -d suhosin.executor.eval.blacklist=none',
 432 >       ],
 433 >
 434 > This is obvious as soon as you notice that the friendica-cron uses `proc_open`
 435 > to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
 436 > I hope this saves some time for other people using suhosin with function blocklists.
 437
 438 ### Unable to create all mysql tables on MySQL 5.7.17 or newer
 439
 440 If the setup fails to create all the database tables and/or manual creation from
 441 the command line fails, with this error:
 442
 443         ERROR 1067 (42000) at line XX: Invalid default value for 'created'
 444
 445 You need to adjust your my.cnf and add the following setting under the [mysqld]
 446 section:
 447
 448         sql_mode = '';
 449
 450 After that, restart mysql and try again.