]> git.mxchange.org Git - friendica.git/blobdiff - doc/Settings.md
Merge pull request #11585 from annando/fix-display
[friendica.git] / doc / Settings.md
index 9f54513fbcd23f46a7ae415e9fcb7b62a4712b0e..16b7ec38a4c76726039836d7e2b8160239e52f36 100644 (file)
@@ -2,18 +2,23 @@
 
 * [Home](help)
 
-If you are the admin of a Friendica node, you have access to the so called **Admin Panel** where you can configure your Friendica node.
+If you are the admin of a Friendica node, you have access to the **Admin Panel** where you can configure your Friendica node.
 
-On the front page of the admin panel you will see a summary of information about your node.
-These information include the amount of messages currently being processed in the queues.
-The first number is the number of messages which could not been delivered for various reasons.
-They will be resend later.
-You can have a quick glance into that second queues in the "Inspect Queue" section of the admin panel.
-The second number represents the current number of jobs for the background workers.
-These worker tasks are prioritised and are done accordingly.
+## Overview
+
+In the main page of the admin panel you will see an information summary about your node.
+
+### Queues
+
+The three numbers shown are respectively:
+- The retry queue: These outgoing messages couldn't be received by the remote host, and will be resent at longer intervals before being dropped entirely after 30 days.
+- The deferred queue: These internal tasks failed and will be retried at most 14 times.
+- The task queue: These internal tasks are queued for execution during the next background worker run.
+
+### Additional information
 
 Then you get an overview of the accounts on your node, which can be moderated in the "Users" section of the panel.
-As well as an overview of the currently active addons
+As well as an overview of the currently active addons.
 The list is linked, so you can have quick access to the Addon settings.
 And finally you are informed about the version of Friendica you have installed.
 If you contact the developers with a bug or problem, please also mention the version of your node.
@@ -69,7 +74,7 @@ You can chose between the following modes:
 ##### Invitation based registry
 
 Additionally to the setting in the admin panel, you can decide if registrations are only possible using an invitation code or not.
-To enable invitation based registration, you have to set the `invitation_only` setting in the [config/local.config.php](/help/Config) file.
+To enable invitation based registration, you have to set the `invitation_only` setting to `true` in the `system` section of the [config/local.config.php](/help/Config) file.
 If you want to use this method, the registration policy has to be set to either *open* or *requires approval*.
 
 #### Check Full Names
@@ -96,6 +101,32 @@ Default is false.
 
 ### File upload
 
+#### File storage backend
+
+Set the backend used by Friendica to store uploaded file data.
+Two storage backends are avaiable with Friendica:
+
+- **Database** : Data is stored in a dedicated table in database (`storage`)
+- **Filesystem** : Data is stored as file on the filesystem.
+
+More storage backends can be avaiable from third-party addons.
+If you use those, please refer to the documentation of those addons for further information.
+
+Default value is 'Database (legacy)': it's the legacy way used to store data directly in database.
+
+Existing data can be moved to the current active backend using the ['storage move' console command](help/tools)
+
+If selected backend has configurable options, new fields are shown here.
+
+##### Filesystem: Storage base path
+
+The base path where Filesystem storage backend saves data.
+
+For maximum security, this path should be outside the folder tree served by the web server: this way files can't be downloaded bypassing the privacy checks.
+
+Default value is `storage`, that is the `storage` folder in Friendica code root folder.
+
+
 #### Maximum Image Size
 
 Maximum size in bytes of uploaded images.
@@ -138,7 +169,6 @@ Your local users will always have access to both pages.
 
 Comma separated list of domains which are allowed to establish friendships with this site.
 Wildcards are accepted.
-(Wildcard support on Windows platforms requires PHP5.3).
 By default, any (valid) domain may establish friendships with this site.
 
 This is useful if you want to setup a closed network for educational groups, cooperatives and similar communities that don't want to communicate with the rest of the network.
@@ -148,12 +178,11 @@ This is useful if you want to setup a closed network for educational groups, coo
 Comma separated list of domains which are allowed in email addresses for registrations to this site.
 This can lockout those who are not part of this organisation from registering here.
 Wildcards are accepted.
-(Wildcard support on Windows platforms requires PHP5.3).
 By default, any (valid) email address is allowed in registrations.
 
 #### Allow Users to set remote_self
 
-If you enable the `Allow Users to set remote_self` users can select Atom feeds from their contact list being their *remote self* in the advanced contact settings.
+If you enable the `Allow Users to set remote_self` users can select Atom feeds from their contact list being their *remote self* in the contact settings.
 Which means that postings by the remote self are automatically reposted by Friendica in their names.
 
 This feature can be used to let the user mirror e.g. blog postings into their Friendica postings.
@@ -211,15 +240,9 @@ This section allows you to configure the background process that is triggered by
 The process does check the available system resources before creating a new worker for a task.
 Because of this, it may happen that the maximum number of worker processes you allow will not be reached.
 
-If your server setup does not allow you to use the `proc_open` function of PHP, please disable it in this section.
-
 The tasks for the background process have priorities.
 To guarantee that important tasks are executed even though the system has a lot of work to do, it is useful to enable the *fastlane*.
 
-Should you not be able to run a cron job on your server, you can also activate the *frontend* worker.
-If you have done so, you can call `example.com/worker` (replace example.com with your actual domain name) on a regular basis from an external service.
-This will then trigger the execution of the background process.
-
 ### Relocate
 
 ## Users
@@ -361,13 +384,13 @@ These are the data base settings, the admin account settings, the path of PHP an
 
 With the following settings, you specify the data base server, the username and password for Friendica and the database to use.
 
-    'database' => [
-        'hostname' => 'localhost',
-        'username' => 'mysqlusername',
-        'password' => 'mysqlpassword',
-        'database' => 'mysqldatabasename',
-        'charset' => 'utf8mb4',
-    ],
+       'database' => [
+               'hostname' => 'localhost',
+               'username' => 'mysqlusername',
+               'password' => 'mysqlpassword',
+               'database' => 'mysqldatabasename',
+               'charset' => 'utf8mb4',
+       ],
 
 ## Admin users
 
@@ -377,17 +400,17 @@ But you can expand the list of email addresses by any used email address you wan
 Registration of new accounts with a listed email address is not possible.
 
        'config' => [
-        'admin_email' => 'you@example.com, buddy@example.com',
-    ],
+               'admin_email' => 'you@example.com, buddy@example.com',
+       ],
 
 ## PHP Path
 
 Some of Friendica's processes are running in the background.
 For this you need to specify the path to the PHP binary to be used.
 
-    'config' => [
-        'php_path' => '/usr/bin/php',
-    ],
+       'config' => [
+               'php_path' => '/usr/bin/php',
+       ],
 
 ## Subdirectory configuration
 
@@ -395,9 +418,9 @@ It is possible to install Friendica into a subdirectory of your web server.
 We strongly discourage you from doing so, as this will break federation to other networks (e.g. Diaspora, GNU Social, Hubzilla)
 Say you have a subdirectory for tests and put Friendica into a further subdirectory, the config would be:
 
-    'system' => [
-        'urlpath' => 'tests/friendica',
-    ],
+       'system' => [
+               'urlpath' => 'tests/friendica',
+       ],
 
 ## Other exceptions