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