Merge remote-tracking branch 'upstream/develop' into item-view

[friendica.git] / doc / Install.md

diff --git a/doc/Install.md b/doc/Install.md
index 117879207e6427b999fb3933826baf42d883ddd0..8d66425a837f5cbcb92aae32920e604ffb9b0065 100644 (file)
--- a/doc/Install.md
+++ b/doc/Install.md
@@ -12,7 +12,7 @@ This kind of functionality requires a bit more of the host system than the typic
 Not every PHP/MySQL hosting provider will be able to support Friendica.
 Many will.
 
 Not every PHP/MySQL hosting provider will be able to support Friendica.
 Many will.
 

-But **please** review the [requirements](#1_2_1) and confirm these with your hosting provider prior to installation.
+But **please** review the [requirements](#Requirements) and confirm these with your hosting provider prior to installation.

 
 ## Support
 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).
 
 ## Support
 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).


@@ -30,10 +30,10 @@ The account will expire after 7 days, but you can ask the server admin to keep y
 
 ### Requirements
 
 
 ### Requirements
 

-* Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
+* Apache with mod-rewrite enabled and "Options All" so you can use a local `.htaccess` file

 * PHP 7+ (PHP 7.1+ is recommended for performance and official support)
   * PHP *command line* access with register_argc_argv set to true in the php.ini file
 * PHP 7+ (PHP 7.1+ is recommended for performance and official support)
   * PHP *command line* access with register_argc_argv set to true in the php.ini file

-  * Curl, GD, PDO, MySQLi, hash, xml, zip and OpenSSL extensions
+  * Curl, GD, PDO, mbstrings, MySQLi, hash, xml, zip and OpenSSL extensions

   * 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)
   * some form of email server or email gateway such that PHP mail() works
 * MySQL 5.6+ or an equivalent alternative for MySQL (MariaDB, Percona Server etc.)
   * 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)
   * some form of email server or email gateway such that PHP mail() works
 * MySQL 5.6+ or an equivalent alternative for MySQL (MariaDB, Percona Server etc.)


@@ -47,7 +47,6 @@ For alternative server configurations (such as Nginx server and MariaDB database
 ### Optional 
 
 * PHP ImageMagick extension (php-imagick) for animated GIF support.
 ### Optional 
 
 * PHP ImageMagick extension (php-imagick) for animated GIF support.

-* [Composer](https://getcomposer.org/) for a git install

 
 ## Installation procedure
 
 
 ## Installation procedure
 


@@ -61,10 +60,11 @@ If this is nothing for you, you might be interested in
 
 ### Get Friendica
 
 
 ### Get Friendica
 

+Download the full archive of the stable release of Friendica core and the addons from [the project homepage](https://friendi.ca/resources/download-files/).
+Make sure that the version of the Friendica archive and the addons match.

 Unpack the Friendica files into the root of your web server document area.
 
 Unpack the Friendica files into the root of your web server document area.
 

-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.
+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.

 
 **OR**
 
 
 **OR**
 


@@ -73,7 +73,7 @@ This makes the software much easier to update.
 
 The Linux commands to clone the repository into a directory "mywebsite" would be
 
 
 The Linux commands to clone the repository into a directory "mywebsite" would be
 

-    git clone https://github.com/friendica/friendica.git -b master mywebsite
+    git clone https://github.com/friendica/friendica.git -b stable mywebsite

     cd mywebsite
     bin/composer.phar install --no-dev
 
     cd mywebsite
     bin/composer.phar install --no-dev
 


@@ -89,7 +89,7 @@ Get the addons by going into your website folder.
 
 Clone the addon repository (separately):
 
 
 Clone the addon repository (separately):
 

-    git clone https://github.com/friendica/friendica-addons.git -b master addon
+    git clone https://github.com/friendica/friendica-addons.git -b stable addon

 
 If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
 
 
 If you want to use the development version of Friendica you can switch to the develop branch in the repository by running
 


@@ -108,11 +108,12 @@ Create an empty database and note the access details (hostname, username, passwo
 
 Friendica needs the permission to create and delete fields and tables in its own database.
 
 
 Friendica needs the permission to create and delete fields and tables in its own database.
 

-Please check the [troubleshooting](#1_6) section if running on MySQL 5.7.17 or newer.
+Please check the [troubleshooting](#Troubleshooting) section if running on MySQL 5.7.17 or newer.

 
 ### Option A: Run the installer
 
 
 ### Option A: Run the installer
 

-Point your web browser to the new site and follow the instructions.
+Before you point your web browser to the new site you need to copy `.htaccess-dist` to `.htaccess` for Apache installs.
+Follow the instructions.

 Please note any error messages and correct these before continuing.
 
 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.
 Please note any error messages and correct these before continuing.
 
 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.


@@ -153,7 +154,7 @@ If you wish to include all optional checks, use `-a` like this statement:
 
 #### B.1: Config file
 
 
 #### B.1: Config file
 

-You can use a prepared config file like [local-sample.config.php](config/local-sample.config.php).
+You can use a prepared config file like [local-sample.config.php](/config/local-sample.config.php).

 
 Navigate to the main Friendica directory and execute the following command:
 
 
 Navigate to the main Friendica directory and execute the following command:
 


@@ -328,7 +329,7 @@ If the database resides on the same machine, check that the database server name
 ### 500 Internal Error
 
 This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.
 ### 500 Internal Error
 
 This could be the result of one of our Apache directives not being supported by your version of Apache. Examine your apache server logs.

-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.
+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.

 Also check your file permissions. Your website and all contents must generally be world-readable.
 
 It is likely that your web server reported the source of the problem in its error log files.
 Also check your file permissions. Your website and all contents must generally be world-readable.
 
 It is likely that your web server reported the source of the problem in its error log files.


@@ -435,7 +436,7 @@ provided by one of our members.
 > 
 > This is obvious as soon as you notice that the friendica-cron uses `proc_open`
 > to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.
 > 
 > This is obvious as soon as you notice that the friendica-cron uses `proc_open`
 > to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out.

-> I hope this saves some time for other people using suhosin with function blacklists.
+> I hope this saves some time for other people using suhosin with function blocklists.

 
 ### Unable to create all mysql tables on MySQL 5.7.17 or newer
 
 
 ### Unable to create all mysql tables on MySQL 5.7.17 or newer