Merge remote-tracking branch 'upstream/develop' into 1612-unused-indexes

doc/Plugins.md

@@ -77,9 +77,9 @@ This will include:
     $a->argc = 3
     $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
 
-Your module functions will often contain the function plugin_name_content(&$a), which defines and returns the page body content.
-They may also contain plugin_name_post(&$a) which is called before the _content function and typically handles the results of POST forms.
-You may also have plugin_name_init(&$a) which is called very early on and often does module initialisation.
+Your module functions will often contain the function plugin_name_content(App &$a), which defines and returns the page body content.
+They may also contain plugin_name_post(App &$a) which is called before the _content function and typically handles the results of POST forms.
+You may also have plugin_name_init(App &$a) which is called very early on and often does module initialisation.
 
 Templates
 ---

doc/SSL.md

@@ -3,15 +3,15 @@ Using SSL with Friendica
 
 * [Home](help)
 
-Disclaimer
----
+## Disclaimer
+
 **This document has been updated in November 2016.
 SSL encryption is relevant for security.
 This means that recommended settings change fast.
 Keep your setup up to date and do not rely on this document being updated as fast as technologies change!**
 
-Intro
----
+## Intro
+
 If you are running your own Friendica site, you may want to use SSL (https) to encrypt communication between servers and between yourself and your server.
 
 There are basically two sorts of SSL certificates: Self-signed certificates and certificates signed by a certificate authority (CA).
@@ -26,15 +26,13 @@ Normally, you have to pay for them - and they are valid for a limited period of
 
 There are ways to get a trusted certificate for free.
 
-Chose your domain name
----
+## Choose your domain name
 
 Your SSL certificate will be valid for a domain or even only for a subdomain.
 Make your final decision about your domain resp. subdomain *before* ordering the certificate.
 Once you have it, changing the domain name means getting a new certificate.
 
-Shared hosts
----
+### Shared hosts
 
 If your Friendica instance is running on a shared hosting platform, you should first check with your hosting provider.
 They have instructions for you on how to do it there.
@@ -45,8 +43,7 @@ They need the certificate, the key and the CA's intermediate certificate.
 To be sure, send those three files.
 **You should send them to your provider via an encrypted channel!**
 
-Own server
----
+### Own server
 
 If you run your own server, we recommend to check out the ["Let's Encrypt" initiative](https://letsencrypt.org/).
 Not only do they offer free SSL certificates, but also a way to automate their renewal.
@@ -54,14 +51,48 @@ You need to install a client software on your server to use it.
 Instructions for the official client are [here](https://certbot.eff.org/).
 Depending on your needs, you might want to look at the [list of alternative letsencrypt clients](https://letsencrypt.org/docs/client-options/).
 
-
-Web server settings
----
+## Web server settings
 
 Visit the [Mozilla's wiki](https://wiki.mozilla.org/Security/Server_Side_TLS) for instructions on how to configure a secure webserver.
 They provide recommendations for [different web servers](https://mozilla.github.io/server-side-tls/ssl-config-generator/).
 
-Test your SSL settings
----
+## Test your SSL settings
 
 When you are done, visit the test site [SSL Labs](https://www.ssllabs.com/ssltest/) to have them check if you succeeded.
+
+## Configure Friendica
+
+If you can successfully access your Friendica instance through https, there are a number of steps you can take to ensure your users will use SSL to access your instance.
+
+### Web server redirection
+
+This is the simplest way to enforce site-wide secure access.
+Every time a user tries to access any Friendica page by any mean (manual address bar entry or link), the web server issues a Permanent Redirect response with the secure protocol prepended to the requested URL.
+
+With Apache, simply add the following lines to the [code].htaccess[/code] file in the root folder of your Friendica instance (thanks to [url=https://github.com/AlfredSK]AlfredSK[/url]):
+
+[code]
+#Force SSL connections
+
+RewriteEngine On
+RewriteCond %{SERVER_PORT} 80
+RewriteRule ^(.*)$ https://your.friendica.domain/$1 [R=301,L]
+[/code]
+
+With nginx, configure your [code]server[/code] directive this way (thanks to [url=https://bjornjohansen.no/redirect-to-https-with-nginx/]Bjørn Johansen[/url]):
+
+[code]
+server {
+	listen 80;
+	listen [::]:80;
+	server_name your.friendica.domain;
+	return 301 https://$server_name$request_uri;
+}
+[/code]
+
+### SSL Settings
+
+In the Admin Settings, there are three SSL-related settings:
+- **SSL link policy**: this affects how Friendica generates internal links. If your SSL installation was successful, we recommend "Force all links to SSL" just in case your web server configuration can't be altered like described above.
+- **Force SSL**: This forces all external links to HTTPS, which may solve Mixed-Content issues, but not all websites support HTTPS yet. Use at your own risk.
+- **Verify SSL**: Enabling this will prevent Friendica to interact with self-signed SSL sites. We recommend you leave it on as a self-signed SSL certificate can be a vectorfor a man-in-the-middle attack.

doc/autoloader.md

@@ -68,7 +68,7 @@ The code will be something like:
     file: mod/network.php
     <?php
     
-    function network_content(&$a) {
+    function network_content(App &$a) {
        $itemsmanager = new \Friendica\ItemsManager();
        $items = $itemsmanager->getAll();
     

doc/de/Plugins.md

@@ -67,9 +67,9 @@ So würde http://example.com/plugin/arg1/arg2 nach einem Modul "plugin" suchen u
     $a->argc = 3
     $a->argv = array(0 => 'plugin', 1 => 'arg1', 2 => 'arg2');
 
-Deine Modulfunktionen umfassen oft die Funktion plugin_name_content(&$a), welche den Seiteninhalt definiert und zurückgibt.
-Sie können auch plugin_name_post(&$a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
-Du kannst ebenso plugin_name_init(&$a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
+Deine Modulfunktionen umfassen oft die Funktion plugin_name_content(App &$a), welche den Seiteninhalt definiert und zurückgibt.
+Sie können auch plugin_name_post(App &$a) umfassen, welches vor der content-Funktion aufgerufen wird und normalerweise die Resultate der POST-Formulare handhabt.
+Du kannst ebenso plugin_name_init(App &$a) nutzen, was oft frühzeitig aufgerufen wird und das Modul initialisert.
 
 
 Derzeitige Hooks

doc/themes.md

@@ -122,7 +122,7 @@ the 1st part of the line is the name of the CSS file (without the .css) the 2nd
 Calling the t() function with the common name makes the string translateable.
 The selected 1st part will be saved in the database by the theme_post function.
 
-    function theme_post(&$a){
+    function theme_post(App &$a){
         // non local users shall not pass
         if (! local_user()) {
             return;
@@ -168,7 +168,7 @@ The content of this file should be something like
 
     <?php
     /* meta informations for the theme, see below */
-    function duepuntozero_lr_init(&$a) {
+    function duepuntozero_lr_init(App &$a) {
         $a-> theme_info = array(
             'extends' => 'duepuntozero'.
         );
@@ -251,7 +251,7 @@ Next crucial part of the theme.php file is a definition of an init function.
 The name of the function is <theme-name>_init.
 So in the case of quattro it is
 
-    function quattro_init(&$a) {
+    function quattro_init(App &$a) {
       $a->theme_info = array();
       set_template_engine($a, 'smarty3');
     }