* [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.
-
-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 being actively sent.
-This number should decrease quickly.
-The second is the messages which could for various reasons not being delivered.
-They will be resend later.
-You can have a quick glance into that second queus in the "Inspect Queue" section of the admin panel.
-If you have activated the background workers, there is a third number representing the count of jobs queued for the workers.
-These worker tasks are prioritised and are done accordingly.
+If you are the admin of a Friendica node, you have access to the **Admin Panel** where you can configure your Friendica node.
+
+## 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
-The list is linked, so you can have quick access to the plugin settings.
+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 devs with a bug or problem, please also mention the version of your node.
+If you contact the developers with a bug or problem, please also mention the version of your node.
-The admin panel is seperated into subsections accessible from the side bar of the panel.
+The admin panel is separated into subsections accessible from the side bar of the panel.
## Site
Set the content for the site banner.
The default logo is the Friendica logo and name.
-You may wish to provide HTML/CSS to style and/or position this content, as it may not be themed by default.
+You may wish to provide HTML/CSS to style and/or position this content, as it may not be themed by default.
#### Language
It is used as fall back setting should Friendica fail to recognize the visitors preferences and can be overwritten by user settings.
The Friendica community offers some translations.
-Some more compleate then others.
+Some more complete then others.
See [this help page](/help/translations) for more information about the translation process.
#### System Theme
Choose a theme to be the default system theme.
This can be over-ridden by user profiles.
-Default theme is "duepunto zero" at the moment.
+Default theme is `vier` at the moment.
You may also want to set a special theme for mobile interfaces.
-Which may or may not be neccessary depending of the mobile friendlyness of the desktop theme you have chosen.
+Which may or may not be necessary depending of the mobile friendliness of the desktop theme you have chosen.
The `vier` theme for instance is mobile friendly.
### Registration
+#### Register policy
+
+With this drop down selector you can set the nodes registration policy.
+You can chose between the following modes:
+
+* **open**: Everybody can register a new account and start using it right away.
+* **requires approval**: Everybody can register a new account, but the admin has to approve it before it can be used.
+* **closed**: No new registrations are possible.
+
+##### 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.
+If you want to use this method, the registration policy has to be set to either *open* or *requires approval*.
+
#### Check Full Names
You may find a lot of spammers trying to register on your site.
During testing we discovered that since these registrations were automatic, the "Full Name" field was often set to just an account name with no space between first and last name.
If you would like to support people with only one name as their full name, you may change this setting to true.
Default is false.
-
+
#### OpenID
By default, OpenID may be used for both registration and logins.
Your site configuration can block registration (or require approval to register).
By default, logged in users can register additional accounts for use as pages.
These will still require approval if the registration policy is set to *require approval*
-You may prohibit logged in users from creating additional accounts by setting *block multible registrations* to true.
+You may prohibit logged in users from creating additional accounts by setting *block multiple registrations* to true.
Default is false.
-
+
### File upload
#### Maximum Image Size
This configures the URL to update the global directory, and is supplied in the default configuration.
The undocumented part is that if this is not set, the global directory is completely unavailable to the application.
-This allows a private community to be completely isolated from the global network.
+This allows a private community to be completely isolated from the global network.
#### Force Publish
Default is false.
Available in version 2.2 or greater.
+#### Community pages for Visitors
+
+The community pages show all public postings, separated by their origin being local or the entire network.
+With this setting you can select which community pages will be shown to visitors of your Friendica node.
+Your local users will always have access to both pages.
+
+**Note**: Several settings, like users hiding their contacts from the public will prevent the postings to show up on the global community page.
+
#### Allowed Friend Domains
Comma separated list of domains which are allowed to establish friendships with this site.
(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, cooperations and similar communities that don't want to commuicate with the rest of the network.
+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.
#### Allowed Email Domains
(Wildcard support on Windows platforms requires PHP5.3).
By default, any (valid) email address is allowed in registrations.
-#### Allow Users to set remote_self
+#### 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 die 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 advanced 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.
+It is disabled by default, as it causes additional load on the server and may be misused to distribute SPAM.
+
As admin of the node you can also set this flag directly in the database.
Before doing so, you should be sure you know what you do and have a backup of the database.
+#### Explicit Content
+
+If you are running a node with explicit content, you can announce this with this option.
+When checked an information flag will be set in the published information about your node.
+(Should *Publish Server Information* be enabled.)
+
+Additionally a note will be displayed on the registration page for new users.
+
### Advanced
#### Proxy Configuration Settings
Default is 60 seconds.
Set to 0 for unlimited (not recommended).
-#### UTF-8 Regular Expressions
-
-During registrations, full names are checked using UTF-8 regular expressions.
-This requires PHP to have been compiled with a special setting to allow UTF-8 expressions.
-If you are completely unable to register accounts, set no_utf to true.
-The default is set to false (meaning UTF8 regular expressions are supported and working).
-
-#### Verify SSL Certitificates
+#### Verify SSL Certificates
By default Friendica allows SSL communication between websites that have "self-signed" SSL certificates.
For the widest compatibility with browsers and other networks we do not recommend using self-signed certificates, but we will not prevent you from using them.
SSL encrypts all the data transmitted between sites (and to your browser).
This allows you to have completely encrypted communications, and also protect your login session from hijacking.
-Self-signed certificates can be generated for free, without paying top-dollar for a website SSL certificate.
+Self-signed certificates can be generated for free, without paying top-dollar for a website SSL certificate.
However these aren't looked upon favourably in the security community because they can be subject to so-called "man-in-the-middle" attacks.
If you wish, you can turn on strict certificate checking.
This will mean you cannot connect (at all) to self-signed SSL sites.
+#### Check upstream version
+
+If this option is enabled your Friendica node will check the upstream version once per day from the github repository.
+You can select if the stable version or the development version should be checked out.
+If there is a new version published, you will get notified in the admin panel summary page.
+
### Auto Discovered Contact Directory
### Performance
### Worker
+This section allows you to configure the background process that is triggered by the `cron` job that was created during the installation.
+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
Here the admin can also block/unblock users from accessing the node or delete the accounts entirely.
In the last section of the page admins can create new accounts on the node.
-The password for the new account will be send by email to the choosen email address.
+The password for the new account will be send by email to the chosen email address.
-## Plugins
+## Addons
This page is for selecting and configuration of extensions for Friendica which have to be placed into the `/addon` subdirectory of your Friendica installation.
You are presented with a long list of available addons.
-The name of each addon is linked to a separate page for that addon which offers more informations and configuration possibilities.
+The name of each addon is linked to a separate page for that addon which offers more information and configuration possibilities.
Also shown is the version of the addon and an indicator if the addon is currently active or not.
When you update your node and the addons they may have to be reloaded.
-To simplify this process there is a button at the top of the page to reload all active plugins.
+To simplify this process there is a button at the top of the page to reload all active Addons.
## Themes
-The Themes section of the admin panel works similar to the Plugins section but let you control the themes on your Friendica node.
-Each theme has a dedicated suppage showing the current status, some information about the theme and a screen-shot of the Friendica interface using the theme.
+The Themes section of the admin panel works similar to the Addons section but let you control the themes on your Friendica node.
+Each theme has a dedicated subpage showing the current status, some information about the theme and a screen-shot of the Friendica interface using the theme.
Should the theme offer special settings, admins can set a global default value here.
You can activate and deactivate themes on their dedicated sub-pages thus making them available for the users of the node.
## Additional Features
-There are several optional features in Friendica.
-Like the *dislike* button or the usage of a *richtext editor* for composing new postings.
+There are several optional features in Friendica like the *dislike* button.
In this section of the admin panel you can select a default setting for your node and eventually fix it, so users cannot change the setting anymore.
## DB Updates
Should the database structure of Friendica change, it will apply the changes automatically.
-In case you are suspecious that the update might not have worked, you can use this section of the admin panel to check the situation.
+In case you are suspecting the update might not have worked, you can use this section of the admin panel to check the situation.
## Inspect Queue
In the admin panel summary there are two numbers for the message queues.
The second number represents messages which could not be delivered and are queued for later retry.
-If this number goes sky-rocking you might ask yourself which receopiant is not receiving.
+If this number goes sky-rocking you might ask yourself which recipient is not receiving.
Behind the inspect queue section of the admin panel you will find a list of the messages that could not be delivered.
-The listing is sorted by the receipiant name so identifying potential broken communication lines should be simple.
+The listing is sorted by the recipient name so identifying potential broken communication lines should be simple.
These lines might be broken for various reasons.
The receiving end might be off-line, there might be a high system load and so on.
Don't panic!
Friendica will not queue messages for all time but will sort out *dead* nodes automatically after a while and remove messages from the queue then.
+## Server Blocklist
+
+This page allows to block all communications (inbound and outbound) with a specific domain name.
+Each blocked domain entry requires a reason that will be displayed on the [friendica](/friendica) page.
+Matching is exact, blocking a domain doesn't block subdomains.
+
## Federation Statistics
The federation statistics page gives you a short summery of the nodes/servers/pods of the decentralized social network federation your node knows.
-These numbers are not compleate and only contain nodes from networks Friendica federates directly with.
+These numbers are not complete and only contain nodes from networks Friendica federates directly with.
+
+## Delete Item
+
+Using this page an admin can delete postings and eventually associated discussion threads from their Friendica node.
+To do so, they need to know the GUID of the posting.
+This can be found on the `/display` page of the posting, it is the last part of the URL displayed in the browsers navigation bar.
+You can get to the `/display` page by following the *Link to source*.
-## Plugin Features
+## Addon Features
Some of the addons you can install for your Friendica node have settings which have to be set by the admin.
All those addons will be listed in this area of the admin panels side bar with their names.
## Logs
-The log section of the admin panel is seperated into two pages.
+The log section of the admin panel is separated into two pages.
On the first, following the "log" link, you can configure how much Friendica shall log.
And on the second you can read the log.
You should not place your logs into any directory that is accessible from the web.
If you have to, and you are using the default configuration from Apache, you should choose a name for the logfile ending in ``.log`` or ``.out``.
-Should you use another web server, please make sure that you have the correct accessrules in place so that your log files are not accessible.
+Should you use another web server, please make sure that you have the correct access rules in place so that your log files are not accessible.
There are five different log levels: Normal, Trace, Debug, Data and All.
-Specifying different verbosities of information and data written out to the log file.
+Specifying different verbosity of information and data written out to the log file.
Normally you should not need to log at all.
The *DEBUG* level will show a good deal of information about system activity but will not include detailed data.
In the *ALL* level Friendica will log everything to the file.
**Known Issues**: The filename ``friendica.log`` can cause problems depending on your server configuration (see [issue 2209](https://github.com/friendica/friendica/issues/2209)).
-By default PHP warnings and error messages are supressed.
-If you want to enable those, you have to activate them in the ``.htconfig.php`` file.
-Use the following settings to redirect PHP errors to a file.
+By default PHP warnings and error messages are suppressed.
+If you want to enable those, you have to activate them in the ``config/local.config.php`` file.
+Use the following settings to redirect PHP errors to a file.
Config:
Undeclared variables are occasionally referenced in the program and therefore we do not recommend using `E_NOTICE` or `E_ALL`.
The vast majority of issues reported at these levels are completely harmless.
Please report to the developers any errors you encounter in the logs using the recommended settings above.
-They generally indicate issues which need to be resolved.
+They generally indicate issues which need to be resolved.
If you encounter a blank (white) page when using the application, view the PHP logs - as this almost always indicates an error has occurred.
## Diagnostics
-In this section of the admin panel you find two tools to investigate what Friendica sees for certain ressources.
+In this section of the admin panel you find two tools to investigate what Friendica sees for certain resources.
These tools can help to clarify communication problems.
For the *probe address* Friendica will display information for the address provided.
## DB Settings
-With the following settings, you specify the data base server, the username and passwort for Friendica and the database to use.
+With the following settings, you specify the data base server, the username and password for Friendica and the database to use.
- $db_host = 'your.db.host';
- $db_user = 'db_username';
- $db_pass = 'db_password';
- $db_data = 'database_name';
+ 'database' => [
+ 'hostname' => 'localhost',
+ 'username' => 'mysqlusername',
+ 'password' => 'mysqlpassword',
+ 'database' => 'mysqldatabasename',
+ 'charset' => 'utf8mb4',
+ ],
## Admin users
But you can expand the list of email addresses by any used email address you want.
Registration of new accounts with a listed email address is not possible.
- $a->config['admin_email'] = 'you@example.com, buddy@example.com';
+ 'config' => [
+ 'admin_email' => 'you@example.com, buddy@example.com',
+ ],
## PHP Path
-Some of Friendicas processes are running in the background.
+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.
- $a->config['php_path'] = '{{$phpath}}';
+ 'config' => [
+ 'php_path' => '/usr/bin/php',
+ ],
## Subdirectory configuration
-It is possible to install Friendica into a subdirectory of your webserver.
-We strongly discurage you from doing so, as this will break federation to other networks (e.g. Diaspora, GNU Socia, Hubzilla)
+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:
- $a->path = 'tests/friendica';
+ 'system' => [
+ 'urlpath' => 'tests/friendica',
+ ],
## Other exceptions
-Furthermore there are some experimental settings, you can read-up in the [Config values that can only be set in .htconfig.php](help/htconfig) section of the documentation.
+Furthermore there are some experimental settings, you can read-up in the [Config values that can only be set in config/local.config.php](help/Config) section of the documentation.
projects / friendica.git / blobdiff