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 But be aware that Friendica is more than a simple web application.
   6 It is a complex communications system which more closely resembles an email server than a web server.
   7 For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
   8 This kind of functionality requires a bit more of the host system than the typical blog.
   9 Not every PHP/MySQL hosting provider will be able to support Friendica.
  10 Many will.
  11 But **please** review the requirements and confirm these with your hosting provider prior to installation.
  12
  13 Also 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).
  14 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.
  15 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.
  16 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.
  17 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.
  18
  19 Before you begin: Choose a domain name or subdomain name for your server.
  20 Put some thought into this. Changing it after installation is currently not supported.
  21 Things will break, and some of your friends may have difficulty communicating with you.
  22 We plan to address this limitation in a future release.
  23
  24
  25 Requirements
  26 ---
  27
  28 * Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
  29 * PHP 5.6+ (PHP 7 is recommended for performance)
  30 * PHP *command line* access with register_argc_argv set to true in the php.ini file
  31 * Curl, GD, PDO, MySQLi, hash, xml and OpenSSL extensions
  32 * some form of email server or email gateway such that PHP mail() works
  33 * Mysql 5.5.3+ or an equivalant alternative for MySQL (MariaDB, Percona Server etc.)
  34 * the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 of this document.)
  35 * Installation into a top-level domain or sub-domain (without a directory/path component in the URL) is preferred. Directory paths will not be as convenient to use and have not been thoroughly tested.
  36 * If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
  37
  38 Installation procedure
  39 ---
  40
  41 ###Get Friendica
  42
  43 Unpack the Friendica files into the root of your web server document area.
  44 If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file.
  45 This makes the software much easier to update.
  46 The Linux commands to clone the repository into a directory "mywebsite" would be
  47
  48     git clone https://github.com/friendica/friendica.git mywebsite
  49     cd mywebsite
  50     util/composer.phar install
  51
  52 Make sure the folder *view/smarty3* exists and is writable by the webserver user
  53
  54     mkdir view/smarty3
  55     chmod 777 view/smarty3
  56
  57 Get the addons by going into your website folder.
  58
  59     cd mywebsite
  60
  61 Clone the addon repository (separately):
  62
  63     git clone https://github.com/friendica/friendica-addons.git addon
  64
  65 If you copy the directory tree to your webserver, make sure that you also copy .htaccess - as "dot" files are often hidden and aren't normally copied.
  66
  67 ###Create a database
  68
  69 Create an empty database and note the access details (hostname, username, password, database name).
  70
  71 Friendica needs the permission to create and delete fields and tables in its own database.
  72
  73 With newer releases of MySQL (5.7.17 or newer), you might need to set the sql_mode to '' (blank).
  74 Use this setting when the installer is unable to create all the needed tables due to a timestamp format problem.
  75 In this case find the [mysqld] section in your my.cnf file and add the line :
  76
  77     sql_mode = ''
  78
  79 Restart mysql and you should be fine.
  80
  81
  82 ###Run the installer
  83
  84 Point your web browser to the new site and follow the instructions.
  85 Please note any error messages and correct these before continuing.
  86
  87 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.
  88
  89 *If* the automated installation fails for any reason, check the following:
  90
  91 * Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php
  92 * Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or mysql command line.
  93
  94 At this point visit your website again, and register your personal account.
  95 Registration errors should all be recoverable automatically.
  96 If you get any *critical* failure at this point, it generally indicates the database was not installed correctly.
  97 You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh.
  98
  99 ###Set up the worker
 100
 101 Set up a cron job or scheduled task to run the worker once every 5-10 minutes in order to perform background processing.
 102 Example:
 103
 104     cd /base/directory; /path/to/php scripts/worker.php
 105
 106 Change "/base/directory", and "/path/to/php" as appropriate for your situation.
 107
 108 If you are using a Linux server, run "crontab -e" and add a line like the
 109 one shown, substituting for your unique paths and settings:
 110
 111     */10 * * * * cd /home/myname/mywebsite; /usr/bin/php scripts/worker.php
 112
 113 You can generally find the location of PHP by executing "which php".
 114 If you run into trouble with this section please contact your hosting provider for assistance.
 115 Friendica will not work correctly if you cannot perform this step.
 116
 117 If it is not possible to set up a cron job then please activate the "frontend worker" in the administration interface.
 118
 119 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
 120
 121 ###Set up a backup plan
 122 Bad things will happen.
 123 Let there be a hardware failure, a corrupted database or whatever you can think of.
 124 So once the installation of your Friendica node is done, you should make yourself a backup plan.
 125
 126 The most important file is the `.htconfig.php` file in the base directory.
 127 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.