]> git.mxchange.org Git - friendica.git/blob - doc/Install.md
Merge pull request #12046 from nupplaphil/bug/DI_missing
[friendica.git] / 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.3+ (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, GMP, 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     If you cannot set up your own email server, you can use the [phpmailer](https://github.com/friendica/friendica-addons/tree/develop/phpmailer) addon and use a remote SMTP server.
37 * MySQL with support of InnoDB and Barracuda (we suggest a MariaDB server as all development is done using these, but alternatives like MySQL or Percona Server etc. might work as well)
38 * ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows)
39 * 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.
40
41 **If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.**
42
43 For alternative server configurations (such as Nginx server and MariaDB database engine), refer to the [Friendica wiki](https://github.com/friendica/friendica/wiki).
44
45 ### Optional 
46
47 * PHP ImageMagick extension (php-imagick) for animated GIF support.
48
49 ## Installation procedure
50
51 ### Alternative Installation Methods
52
53 This guide will walk you through the manual installation process of Friendica.
54 If this is nothing for you, you might be interested in
55
56 * the [Friendica Docker image](https://github.com/friendica/docker) or
57 * how to [install Friendica with YunoHost](https://github.com/YunoHost-Apps/friendica_ynh).
58
59 ### Get Friendica
60
61 Download the full archive of the stable release of Friendica core and the addons from [the project homepage](https://friendi.ca/resources/download-files/).
62 Make sure that the version of the Friendica archive and the addons match.
63 Unpack the Friendica files into the root of your web server document area.
64
65 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.
66
67 **OR**
68
69 Clone the [friendica/friendica GitHub repository](https://github.com/friendica/friendica) and import dependencies.
70 This makes the software much easier to update.
71
72 The Linux commands to clone the repository into a directory "mywebsite" would be
73
74     git clone https://github.com/friendica/friendica.git -b stable mywebsite
75     cd mywebsite
76     bin/composer.phar install --no-dev
77
78 Make sure the folder *view/smarty3* exists and is writable by the webserver user, in this case *www-data*
79
80     mkdir -p view/smarty3
81     chown www-data:www-data view/smarty3
82     chmod 775 view/smarty3
83
84 Get the addons by going into your website folder.
85
86     cd mywebsite
87
88 Clone the addon repository (separately):
89
90     git clone https://github.com/friendica/friendica-addons.git -b stable addon
91
92 If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
93
94     git checkout develop
95     bin/composer.phar install
96     cd addon
97     git checkout develop
98
99 **Be aware that the develop branch is unstable and may break your Friendica node at any time.**
100 You should have a recent backup before updating.
101 If you encounter a bug, please let us know.
102
103 ### Create a database
104
105 Create an empty database and note the access details (hostname, username, password, database name). 
106 Generate a strong password, then enter mysql with:
107
108     mysql
109     
110 Then use the following script using the password you just generated:
111
112     CREATE DATABASE friendicadb;
113     CREATE USER 'friendica'@'localhost' IDENTIFIED BY '<<your mysql password here>>';
114     GRANT ALL ON friendicadb.* TO 'friendica'@'localhost';
115     FLUSH PRIVILEGES;
116     EXIT;
117
118 Friendica needs the permission to create and delete fields and tables in its own database.
119
120 Please check the [troubleshooting](#Troubleshooting) section if running on MySQL 5.7.17 or newer.
121
122 ### Option A: Run the installer
123
124 Before you point your web browser to the new site you need to copy `.htaccess-dist` to `.htaccess` for Apache installs.
125 Follow the instructions.
126 Please note any error messages and correct these before continuing.
127
128 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.
129
130 *If* the manual installation fails for any reason, check the following:
131
132 * Does `config/local.config.php` exist? If not, edit `config/local-sample.config.php` and change the system settings.
133 * Rename to `config/local.config.php`.
134 * Is the database populated? If not, import the contents of `database.sql` with phpmyadmin or the mysql command line.
135
136 At this point visit your website again, and register your personal account.
137 Registration errors should all be recoverable automatically.
138 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
139 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.
140
141 ### Option B: Run the automatic install script
142
143 You have the following options to automatically install Friendica:
144 -       creating a prepared config file (f.e. `prepared.config.php`)
145 -       using environment variables (f.e. `MYSQL_HOST`)
146 -       using options (f.e. `--dbhost <host>`)
147
148 You can combine environment variables and options, but be aware that options are prioritized over environment variables. 
149
150 For more information during the installation, you can use this command line option
151
152     bin/console autoinstall -v
153
154 If you wish to include all optional checks, use `-a` like this statement:
155
156     bin/console autoinstall -a
157     
158 *If* the automatic installation fails for any reason, check the following:
159
160 *       Does `config/local.config.php` already exist? If yes, the automatic installation won't start
161 *       Are the options in the `config/local.config.php` correct? If not, edit them directly.
162 *       Is the empty MySQL-database created? If not, create it.
163
164 #### B.1: Config file
165
166 You can use a prepared config file like [local-sample.config.php](/config/local-sample.config.php).
167
168 Navigate to the main Friendica directory and execute the following command:
169
170     bin/console autoinstall -f <prepared.config.php>
171     
172 #### B.2: Environment variables
173
174 There are two types of environment variables.
175 -       those you can use in normal mode too (Currently just **database credentials**)
176 -       those you can only use during installation (because Friendica will normally ignore it)
177
178 You can use the options during installation too and skip some of the environment variables.
179
180 **Database credentials**
181
182 if you don't use the option `--savedb` during installation, the DB credentials will **not** be saved in the `config/local.config.php`.
183
184 -       `MYSQL_HOST` The host of the mysql/mariadb database
185 -       `MYSQL_PORT` The port of the mysql/mariadb database
186 -       `MYSQL_USERNAME` The username of the mysql database login (used for mysql)
187 -       `MYSQL_USER` The username of the mysql database login (used for mariadb)
188 -       `MYSQL_PASSWORD` The password of the mysql/mariadb database login
189 -       `MYSQL_DATABASE` The name of the mysql/mariadb database
190
191 **Friendica settings**
192
193 This variables wont be used at normal Friendica runtime.
194 Instead, they get saved into `config/local.config.php`. 
195
196 -       `FRIENDICA_URL_PATH` The URL path of Friendica (f.e. '/friendica')
197 -       `FRIENDICA_PHP_PATH` The path of the PHP binary
198 -       `FRIENDICA_ADMIN_MAIL` The admin email address of Friendica (this email will be used for admin access)
199 -       `FRIENDICA_TZ` The timezone of Friendica
200 -       `FRIENDICA_LANG` The language of Friendica
201
202 Navigate to the main Friendica directory and execute the following command:
203
204     bin/console autoinstall [--savedb]
205
206 #### B.3: Execution options
207
208 All options will be saved in the `config/local.config.php` and are overruling the associated environment variables.
209
210 -       `-H|--dbhost <host>` The host of the mysql/mariadb database (env `MYSQL_HOST`)
211 -       `-p|--dbport <port>` The port of the mysql/mariadb database (env `MYSQL_PORT`)
212 -       `-U|--dbuser <username>` The username of the mysql/mariadb database login (env `MYSQL_USER` or `MYSQL_USERNAME`)
213 -       `-P|--dbpass <password>` The password of the mysql/mariadb database login (env `MYSQL_PASSWORD`)
214 -       `-d|--dbdata <database>` The name of the mysql/mariadb database (env `MYSQL_DATABASE`)
215 -       `-u|--urlpath <url_path>` The URL path of Friendica - f.e. '/friendica' (env `FRIENDICA_URL_PATH`)
216 -       `-b|--phppath <php_path>` The path of the PHP binary (env `FRIENDICA_PHP_PATH`)
217 -       `-A|--admin <mail>` The admin email address of Friendica (env `FRIENDICA_ADMIN_MAIL`)
218 -       `-T|--tz <timezone>` The timezone of Friendica (env `FRIENDICA_TZ`)
219 -       `-L|--lang <language>` The language of Friendica (env `FRIENDICA_LANG`)
220
221 Navigate to the main Friendica directory and execute the following command:
222
223     bin/console autoinstall [options]
224
225 ### Prepare .htaccess file
226
227 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.
228
229 Example:
230
231     cp .htacces-dist .htaccess
232
233 *Note*: Do **not** rename the `.htaccess-dist` file as it is tracked by GIT and renaming will cause a dirty working directory.
234
235 ### Verify the "host-meta" page is working
236
237 Friendica should respond automatically to important addresses under the */.well-known/* rewrite path.
238 One critical URL would look like, for example: https://example.com/.well-known/host-meta   
239 It must be visible to the public and must respond with an XML file that is automatically customized to your site.
240
241 If that URL is not working, it is possible that some other software is using the /.well-known/ path.
242 Other symptoms may include an error message in the Admin settings that says "host-meta is not reachable on your system.
243 This is a severe configuration issue that prevents server to server communication."
244 Another common error related to host-meta is the "Invalid profile URL."
245
246 Check for a `.well-known` directory that did not come with Friendica.
247 The preferred configuration is to remove the directory, however this is not always possible.
248 If there is any /.well-known/.htaccess file, it could interfere with this Friendica core requirement.
249 You should remove any RewriteRules from that file, or remove that whole file if appropriate.
250 It may be necessary to chmod the /.well-known/.htaccess file if you were not given write permissions by default.
251
252 ## Register the admin account
253
254 At this point visit your website again, and register your personal account with the same email as in the `config.admin_email` config value.
255 Registration errors should all be recoverable automatically.
256
257 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly. 
258 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.
259
260 ## Post Install Configuration
261
262 ### (REQUIRED) Background tasks
263
264 Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing.
265 Example:
266
267     cd /base/directory; /path/to/php bin/worker.php
268
269 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
270
271 #### cron job for worker
272
273 If you are using a Linux server, run "crontab -e" and add a line like the
274 one shown, substituting for your unique paths and settings:
275
276     */10 * * * * cd /home/myname/mywebsite; /usr/bin/php bin/worker.php
277
278 You can generally find the location of PHP by executing "which php".
279 If you run into trouble with this section please contact your hosting provider for assistance.
280 Friendica will not work correctly if you cannot perform this step.
281
282 If it is not possible to set up a cron job then please activate the "frontend worker" in the administration interface.
283
284 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.
285
286 #### worker alternative: daemon
287 Otherwise, you’ll need to use the command line on your remote server and start the Friendica daemon (background task) using the following command:
288
289     cd /path/to/friendica; php bin/daemon.php start
290
291 Once started, you can check the daemon status using the following command:
292
293     cd /path/to/friendica; php bin/daemon.php status
294
295 After a server restart or any other failure, the daemon needs to be restarted. 
296 This could be achieved by a cronjob.
297
298 ### (RECOMMENDED) Logging & Log Rotation
299
300 At this point it is recommended that you set up logging and logrotation.
301 To do so please visit [Settings](help/Settings) and search the 'Logs' section for more information.
302
303 ### (RECOMMENDED) Set up a backup plan
304
305 Bad things will happen.
306 Let there be a hardware failure, a corrupted database or whatever you can think of.
307 So once the installation of your Friendica node is done, you should make yourself a backup plan.
308
309 The most important file is the `config/local.config.php` file.
310 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.
311
312 ### (OPTIONAL) Reverse-proxying and HTTPS
313
314 Friendica looks for some well-known HTTP headers indicating a reverse-proxy
315 terminating an HTTPS connection.
316 While the standard from RFC 7239 specifies the use of the `Forwarded` header.
317
318     Forwarded: for=192.0.2.1; proto=https; by=192.0.2.2
319
320 Friendica also supports a number on non-standard headers in common use.
321
322     X-Forwarded-Proto: https
323
324     Front-End-Https: on
325
326     X-Forwarded-Ssl: on
327
328 It is however preferable to use the standard approach if configuring a new server.
329
330 ## Troubleshooting
331
332 ### "System is currently unavailable. Please try again later"
333
334 Check your database settings.
335 It usually means your database could not be opened or accessed.
336 If the database resides on the same machine, check that the database server name is "localhost".
337
338 ### 500 Internal Error
339
340 This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.
341 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.
342 Also check your file permissions. Your website and all contents must generally be world-readable.
343
344 It is likely that your web server reported the source of the problem in its error log files.
345 Please review these system error logs to determine what caused the problem.
346 Often this will need to be resolved with your hosting provider or (if self-hosted) your web server configuration.
347
348 ### 400 and 4xx "File not found" errors
349
350 First check your file permissions.
351 Your website and all contents must generally be world-readable.
352
353 Ensure that mod-rewite is installed and working, and that your `.htaccess` file
354 is being used. To verify the latter, create a file `test.out` containing the
355 word "test" in the top directory of Friendica, make it world readable and point
356 your web browser to
357
358         http://yoursitenamehere.com/test.out
359
360 This file should be blocked. You should get a permission denied message.
361
362 If you see the word "test" your Apache configuration is not allowing your
363 `.htaccess` file to be used (there are rules in this file to block access to any
364 file with .out at the end, as these are typically used for system logs).
365
366 Make certain the `.htaccess` file exists and is readable by everybody, then look
367 for the existence of "AllowOverride None" in the Apache server configuration for your site.
368 This will need to be changed to "AllowOverride All".
369
370 If you do not see the word "test", your `.htaccess` is working, but it is likely
371 that mod-rewrite is not installed in your web server or is not working.
372
373 On most Linux flavors:
374
375         % a2enmod rewrite
376         % /etc/init.d/apache2 restart
377
378 Consult your hosting provider, experts on your particular Linux distribution or
379 (if Windows) the provider of your Apache server software if you need to change
380 either of these and can not figure out how. There is a lot of help available on
381 the web. Search "mod-rewrite" along with the name of your operating system
382 distribution or Apache package (if using Windows).
383
384 ### Unable to write the file config/local.config.php due to permissions issues
385
386 Create an empty `config/local.config.php`file and apply world-write permission.
387
388 On Linux:
389
390         % touch config/local.config.php
391         % chmod 664 config/local.config.php
392
393 Retry the installation. As soon as the database has been created,
394
395 ******* this is important *********
396
397         % chmod 644 config/local.config.php
398
399 ### Suhosin issues
400
401 Some configurations with "suhosin" security are configured without an ability to
402 run external processes. Friendica requires this ability. Following are some notes
403 provided by one of our members.
404
405 > On my server I use the php protection system Suhosin [http://www.hardened-php.net/suhosin/].
406 > One of the things it does is to block certain functions like proc_open, as
407 > configured in `/etc/php5/conf.d/suhosin.ini`:
408
409 >     suhosin.executor.func.blacklist = proc_open, ...
410 >
411 > For those sites like Friendica that really need these functions they can be
412 > enabled, e.g. in `/etc/apache2/sites-available/friendica`:
413 >
414 >       <Directory /var/www/friendica/>
415 >         php_admin_value suhosin.executor.func.blacklist none
416 >         php_admin_value suhosin.executor.eval.blacklist none
417 >       </Directory>
418
419 > This enables every function for Friendica if accessed via browser, but not for
420 > the cronjob that is called via php command line. I attempted to enable it for
421 > cron by using something like:
422
423 >       */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php \
424 >       -d suhosin.executor.func.blacklist=none \
425 >       -d suhosin.executor.eval.blacklist=none -f bin/worker.php
426
427 > This worked well for simple test cases, but the friendica-cron still failed
428 > with a fatal error:
429
430 >       suhosin[22962]: ALERT - function within blacklist called: proc_open()
431 >     (attacker 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php',
432 >     line 1341)
433
434 > After a while I noticed, that `bin/worker.php` calls further PHP script via `proc_open`.
435 > These scripts themselves also use `proc_open` and fail, because they are NOT
436 > called with `-d suhosin.executor.func.blacklist=none`.
437
438 >  So the simple solution is to put the correct parameters into `config/local.config.php`:
439
440 >       'config' => [
441 >               //Location of PHP command line processor
442 >               'php_path' => '/usr/bin/php -d suhosin.executor.func.blacklist=none \
443 >               -d suhosin.executor.eval.blacklist=none',
444 >       ],
445
446 > This is obvious as soon as you notice that the friendica-cron uses `proc_open`
447 > to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
448 > I hope this saves some time for other people using suhosin with function blocklists.
449
450 ### Unable to create all mysql tables on MySQL 5.7.17 or newer
451
452 If the setup fails to create all the database tables and/or manual creation from
453 the command line fails, with this error:
454
455         ERROR 1067 (42000) at line XX: Invalid default value for 'created'
456
457 You need to adjust your my.cnf and add the following setting under the [mysqld]
458 section:
459
460         sql_mode = '';
461
462 After that, restart mysql and try again.
463
464 ### Your worker never or rarely runs
465
466 Friendica is coded to always play nice. It checks whether the host machine is idle enough and if it _seems_ to be overloaded, it intermittently refuses to process the worker queue.
467
468 Such checks originate from the days of single-user single-core machines and involves thresholds that you should adjust based on the number of exclusive CPU cores you have. See this issue for more information:
469
470 * https://github.com/friendica/friendica/issues/10131
471
472 If you want to be neighborly and are using a shared web hosting PaaS provider, especially within the free tier, you need to set `maxloadavg` to say twice the maximum value of `/proc/loadavg` during peak hours.
473
474 If you have the whole (virtual) machine for yourself such as in case of an IaaS VPS, you can set it to orders of magnitude higher than its commonly observed value, such as 1000.
475
476 You should instead enact limits in your web server configuration based on the number of entry processes to cap the concurrent memory usage of your PHP processes.
477 See `RLimitMEM`, `RLimitCPU`, `RLimitNPROC`, `StartServers`, `ServerLimit`, `MaxRequestsPerChild`, `pm.max_children`, `pm.start_servers` and related options in your server.
478
479 ### Error uploading even small image files
480
481 You tried to upload an image up to 100kB and it failed.
482
483 You may not have the ownership or file mode set correctly if you are using the file system storage backend.
484
485 Change the backend to database. If this solves it, that is what needs to be fixed.
486
487 ### Error uploading large files
488
489 You may find `413 Request Entity Too Large` or `500 Internal Error` in the network inspector of the browser if the file is too large, for example if it is a video.
490
491 First try to upload a very small file, up to 100kB. If that succeeds, you will need to increase limits at multiple places, including on any web proxy that you are using.
492
493 In your PHP ini:
494
495 * `upload_max_filesize`: defaults to 2MB
496 * `post_max_size`: defaults to 8MB, must be greater than `upload_max_filesize`
497 * `memory_limit`: defaults to 128MB, must be greater than `post_max_size`
498
499 You should verify whether you changed them in the _right file_ by checking the web interface at the end of the overview on the `Admin` panel.
500
501 For Apache2:
502
503 * `LimitRequestBody`: defaults to unlimited
504 * `SSLRenegBufferSize`: defaults to 128kB, only if your site uses TLS and perhaps only when using `SSLVerifyClient` or `SSLVerifyDepth`
505
506 For nginx:
507
508 * `client_max_body_size`: defaults to 1MB
509
510 If you are using the database backend for storage, increase this in your SQL configuration:
511
512 * `max_allowed_packet`: defaults to 32MB
513
514 If you use the ModSecurity WAF:
515
516 * `SecRequestBodyLimit`: defaults to 12MB
517 * `SecRequestBodyNoFilesLimit`: defaults to 128kB, should not apply to Friendica