## Installation
-Pre-requisite: Register a username at https://www.geonames.org/login and set it in `config/addon.config.php`
+Pre-requisite: Register a username at https://www.geonames.org/login and set it in `config/geonames.config.php`:
- 'geonames' => [
- 'username' => 'your_username'
- ],
+ return [
+ 'geonames' => [
+ 'username' => 'your_username'
+ ],
+ ];
Also visit https://geonames.org/manageaccount and enable access to the free web services.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/geonames.config.php in your Friendica directory and set the correct values there
return [
'geonames' => [
...
]
-You can add two configuration variables for the addon to the `config/addon.config.php` file:
-
- 'gravatar' => [
- 'default_avatar' => 'identicon',
- 'rating' => 'g',
- ],
+You can add two configuration variables for the addon to the `config/gravatar.config.php` file:
+
+ return [
+ 'gravatar' => [
+ 'default_avatar' => 'identicon',
+ 'rating' => 'g',
+ ],
+ ];
[1]: http://www.gravatar.com/site/implement/images/ "See documentation at Gravatar for more information"
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/gravatar.config.php in your Friendica directory and set the correct values there
return [
'gravatar' => [
Manual Configuration
--------------------
-If you for any reason you prefer to use a configuration file instead, you can set the following variables in the `config/addon.config.php` file
+If you for any reason you prefer to use a configuration file instead, you can set the following variables in the `config/impressum.config.php` file
- 'impressum' => [
- 'owner' => '', This is the Name of the Operator
- 'ownerprofile' => '', This is an optional Friendica account where the above owner name will link to
- 'email' => '', A contact email address (optional)
- Will be displayed slightly obfuscated as name(at)example(dot)com
- 'postal' => '', Should contain a postal address where you can be reached at (optional)
- 'notes' => '', Additional informations that should be displayed in the Impressum block
- 'footer_text' => '', Text that will be displayed at the bottom of the pages.
- ],
+ return [
+ 'impressum' => [
+ 'owner' => '', // This is the Name of the Operator
+ 'ownerprofile' => '', // This is an optional Friendica account where the above owner name will link to
+ 'email' => '', // A contact email address (optional)
+ // Will be displayed slightly obfuscated as name(at)example(dot)com
+ 'postal' => '', // Should contain a postal address where you can be reached at (optional)
+ 'notes' => '', // Additional informations that should be displayed in the Impressum block
+ 'footer_text' => '', // Text that will be displayed at the bottom of the pages.
+ ],
+ ];
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/impressum.config.php in your Friendica directory and set the correct values there
return [
'impressum' => [
Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
ldap.conf file to the signing cert for your LDAP server.
-The configuration options for this module may be set in the `config/addon.config.php` file
-e.g.:
-
- 'ldapauth' => [
- // ldap hostname server - required
- 'ldap_server' => '',
-
- // admin dn - optional - only if ldap server dont have anonymous access
- 'ldap_binddn' => '',
-
- // admin password - optional - only if ldap server dont have anonymous access
- 'ldap_bindpw' => '',
-
- // dn to search users - required
- 'ldap_searchdn' => '',
-
- // attribute to find username - required
- 'ldap_userattr' => '',
-
- // DN of the group whose member can auth on Friendica - optional
- 'ldap_group' => '',
-
- // To create Friendica account if user exists in ldap
- // Requires an email and a simple (beautiful) nickname on user ldap object
- // active account creation - optional - default true
- 'ldap_autocreateaccount' => true,
-
- // attribute to get email - optional - default : 'mail'
- 'ldap_autocreateaccount_emailattribute' => 'mail',
-
- // attribute to get nickname - optional - default : 'givenName'
- 'ldap_autocreateaccount_nameattribute' => 'givenName',
- ],
-
-...etc.
+The configuration options for this module are described in the `config/ldapauth.config.php` file.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/ldapauth.config.php in your Friendica directory and set the correct values there
return [
'ldapauth' => [
* Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
* ldap.conf file to the signing cert for your LDAP server.
*
- * The configuration options for this module may be set in the config/addon.config.php file
- * e.g.:
- *
- * [ldapauth]
- * ; ldap hostname server - required
- * ldap_server = host.example.com
- * ; dn to search users - required
- * ldap_searchdn = ou=users,dc=example,dc=com
- * ; attribute to find username - required
- * ldap_userattr = uid
- *
- * ; admin dn - optional - only if ldap server dont have anonymous access
- * ldap_binddn = cn=admin,dc=example,dc=com
- * ; admin password - optional - only if ldap server dont have anonymous access
- * ldap_bindpw = password
- *
- * ; for create Friendica account if user exist in ldap
- * ; required an email and a simple (beautiful) nickname on user ldap object
- * ; active account creation - optional - default none
- * ldap_autocreateaccount = true
- * ; attribute to get email - optional - default : 'mail'
- * ldap_autocreateaccount_emailattribute = mail
- * ; attribute to get nickname - optional - default : 'givenName'
- * ldap_autocreateaccount_nameattribute = cn
- *
- * ...etc.
+ * The configuration options for this module are described in the config/ldapauth.config.php file
*/
use Friendica\App;
Leistungsschutzrecht Addon
==========================
-Main author Michael Vogel
+Main author: Michael Vogel
This addon handles legal problems with the German link tax, named "Leistungsschutzrecht" by shortening preview texts.
-Additionally it is possibly to suppress preview pictures completely to avoid any legal problems.
+Additionally, it is possibly to suppress preview pictures completely to avoid any legal problems.
-## configuration
+## Configuration
-If you want to suppress pictures in previews, add this to your global `config/addon.config.php`:
-
- 'leistungsschutzrecht' => [
- 'suppress_photos' => true,
- ],
+If you want to suppress pictures in previews, add this to your global `config/leistungsschutzrecht.config.php`:
+ return [
+ 'leistungsschutzrecht' => [
+ 'suppress_photos' => true,
+ ],
+ ];
...
]
-You can add one configuration variables for the addon to the `config/addon.config.php` file:
+You can add one configuration variables for the addon to the `config/libravatar.config.php` file:
- 'libravatar' => [
- 'default_avatar' => 'identicon',
- ],
+ return [
+ 'libravatar' => [
+ 'default_avatar' => 'identicon',
+ ],
+ ];
[1]: http://wiki.libravatar.org/api/ "See API documentation at Libravatar for more information"
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/libravatar.config.php in your Friendica directory and set the correct values there
return [
'libravatar' => [
...
]
-and then providing the base URL after that in the `config/addon.config.php` file
+and then providing the base URL after that in the `config/mathjax.config.php` file
- 'mathjax' => [
- 'baseurl' => '[the URL to your MathJax installation]',
- ],
+ return [
+ 'mathjax' => [
+ 'baseurl' => '[the URL to your MathJax installation]',
+ ],
+ ];
Usage
=====
...
]
-You can set configuration variables for the addon in the `config/addon.config.php` file:
+You can set configuration variables for the addon in the `config/openstreetmap.config.php` file:
- 'openstreetmap' => [
- 'tmsserver' => 'https://www.openstreetmap.org',
- 'nomserver' => 'https://nominatim.openstreetmap.org/search.php',
- 'zoom' => 16,
- 'marker' => 0,
- ],
+ return [
+ 'openstreetmap' => [
+ 'tmsserver' => 'https://www.openstreetmap.org',
+ 'nomserver' => 'https://nominatim.openstreetmap.org/search.php',
+ 'zoom' => 16,
+ 'marker' => 0,
+ ],
+ ];
The *tmsserver* points to the tile server you want to use. Use the full URL,
with protocol (http/s) and trailing slash. You can configure the default zoom
level on the map with *zoom*. 1 will show the whole world and 18 is the highest
zoom level available.
-Please see provided `config/openstreetmap.php` file for explanation on the additional configuration keys.
\ No newline at end of file
+Please see provided `config/openstreetmap.php` file for explanation on the additional configuration keys.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/openstreetmap.config.php in your Friendica directory and set the correct values there
return [
'openstreetmap' => [
Configuration
-------------
-You can override the default value of the following config keys in your base Friendica install `config/addon.config.php` file:
-
- 'phpmailer' => [
- // smtp (Boolean)
- // Enables SMTP relaying for outbound emails
- 'smtp' => false,
-
- // smtp_server (String)
- // SMTP server host name
- 'smtp_server' => 'smtp.example.com',
-
- // smtp_port (Integer)
- // SMTP server port number
- 'smtp_port' => 25,
-
- // smtp_secure (String)
- // What kind of encryption to use on the SMTP connection.
- // Options: '', 'ssl' or 'tls'.
- 'smtp_secure' => '',
-
- // smtp_port_s (Integer)
- // Secure SMTP server port number
- 'smtp_port_s' => 465,
-
- // smtp_username (String)
- // SMTP server authentication user name
- // Empty string disables authentication
- 'smtp_username' => '',
-
- // smtp_password (String)
- // SMTP server authentication password
- // Empty string disables authentication
- 'smtp_password' => '',
-
- // smtp_from (String)
- // From address used when using the SMTP server
- // Example: no-reply@example.com
- 'smtp_from' => '',
- ],
+The configuration options for this module are described in the `config/phpmailer.config.php` file.
License
=======
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/phpmailer.config.php in your Friendica directory and set the correct values there
return [
'phpmailer' => [
...
]
-You can change 4 more configuration variables for the addon in the `config/addon.config.php` file:
-
- 'piwik' => [
- 'baseurl' => 'example.com/piwik/',
- 'sideid' => 1,
- 'optout' => true,
- 'async' => false,
- ],
+You can change 4 more configuration variables for the addon in the `config/piwik.config.php` file:
+
+ return [
+ 'piwik' => [
+ 'baseurl' => 'example.com/piwik/',
+ 'sideid' => 1,
+ 'optout' => true,
+ 'async' => false,
+ ],
+ ];
Configuration fields
---------------------
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/piwik.config.php in your Friendica directory and set the correct values there
return [
'piwik' => [
*
* Configuration:
* Use the administration panel to configure the Piwik tracking addon, or
- * in case you don't use this add the following lines to your config/addon.config.php
+ * in case you don't use this, add the following lines to your config/piwik.config.php
* file:
*
- * [piwik]
- * baseurl = example.com/piwik/
- * sideid = 1
- * optout = true ;set to false to disable
- * async = false ;set to true to enable
+ * return [
+ * 'piwik' => [
+ * 'baseurl' => '',
+ * 'sideid' => '',
+ * 'optout' => true,
+ * 'async' => false,
+ * ],
+ * ];
*
* Change the siteid to the ID that the Piwik tracker for your Friendica
* installation has. Alter the baseurl to fit your needs, don't care
DI::page()['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . DI::baseUrl()->get() . '/addon/piwik/piwik.css' . '" media="all" />';
/*
- * Get the configuration variables from the config/addon.config.php file.
+ * Get the configuration values.
*/
$baseurl = DI::config()->get('piwik', 'baseurl');
$siteid = DI::config()->get('piwik', 'siteid');
This is a modified version of the testdrive addon, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE ADDON.
- 'public_server' => [
- // When an account is created on the site, it is given a hard expiration date of. 0 to disable.
- 'expiredays' => 0,
- // Set the default days for posts to expire here. 0 to disable.
- 'expireposts' => 0,
- // Remove users who have never logged in after nologin days. 0 to disable.
- 'nologin' => 0,
- // Remove users who last logged in over flagusers days ago. 0 to disable.
- 'flagusers' => 0,
- // For users who last logged in over flagposts days ago set post expiry days to flagpostsexpire. 0 to disable.
- 'flagposts' => 0,
- 'flagpostsexpire' => 0,
- ],
+ return [
+ 'public_server' => [
+ // When an account is created on the site, it is given a hard expiration date of. 0 to disable.
+ 'expiredays' => 0,
+ // Set the default days for posts to expire here. 0 to disable.
+ 'expireposts' => 0,
+ // Remove users who have never logged in after nologin days. 0 to disable.
+ 'nologin' => 0,
+ // Remove users who last logged in over flagusers days ago. 0 to disable.
+ 'flagusers' => 0,
+ // For users who last logged in over flagposts days ago set post expiry days to flagpostsexpire. 0 to disable.
+ 'flagposts' => 0,
+ 'flagpostsexpire' => 0,
+ ],
+ ];
-Set these in your `config/addon.config.php` file. By default nothing is defined in case the addon is activated accidentally.
+Set these in your `config/public_server.config.php` file. By default, nothing is defined in case the addon is activated accidentally.
They can be ommitted or set to 0 to disable each option.
The default values are those used by friendica.eu, change these as desired.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/public_server.config.php in your Friendica directory and set the correct values there
return [
'public_server' => [
-To let the connector work properly you should define an application name in `config/addon.config.php`:
+To let the connector work properly you should define an application name in `config/pumpio.config.php`:
- 'pumpio' => [
- 'application_name' => '',
- // Displays forwarded posts like "wall-to-wall" posts.
- 'wall-to-wall_share' => false,
- // Given in minutes
- 'poll_interval' => 5,
- ],
+ return [
+ 'pumpio' => [
+ 'application_name' => '',
+ // Displays forwarded posts like "wall-to-wall" posts.
+ 'wall-to-wall_share' => false,
+ // Given in minutes
+ 'poll_interval' => 5,
+ ],
+ ];
This name appears at pump.io and is important for not mirroring back posts that came from Friendica.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/pumpio.config.php in your Friendica directory and set the correct values there
return [
'pumpio' => [
When an account is created on the site, it is given a hard expiration date of
- 'testdrive' => [
- 'expiredays' => 30,
- ],
+ return [
+ 'testdrive' => [
+ 'expiredays' => 30,
+ ],
+ ];
-Set this in your `config/addon.config.php` file to allow a 30 day test drive period.
-By default no expiration period is defined in case the addon is activated accidentally.
+Set this in your `config/testdrive.config.php` file to allow a 30-day test drive period.
+By default, no expiration period is defined in case the addon is activated accidentally.
There is no opportunity to extend an expired account using this addon.
Expiration is final.
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/testdrive.config.php in your Friendica directory and set the correct values there
return [
'testdrive' => [
...
]
-Add your key pair to your global `config/addon.config.php`.
-
- 'twitter' => [
- 'consumerkey' => 'your consumer_key here',
- 'consumersecret' => 'your consumer_secret here',
- ],
+Add your key pair to your `config/twitter.config.php` file.
+
+ return [
+ 'twitter' => [
+ 'consumerkey' => 'your consumer_key here',
+ 'consumersecret' => 'your consumer_secret here',
+ ],
+ ];
After this, users can configure their Twitter account settings from "Settings -> Addon Settings".
<?php
// Warning: Don't change this file! It only holds the default config values for this addon.
-// Instead overwrite these config values in config/addon.config.php in your Friendica directory
+// Instead, copy this file to config/twitter.config.php in your Friendica directory and set the correct values there
return [
'twitter' => [
* we do not need "Twitter as login". When you've registered the app you get the
* OAuth Consumer key and secret pair for your application/site.
*
- * Add this key pair to your global config/addon.config.php or use the admin panel.
+ * Add this key pair to your config/twitter.config.php file or use the admin panel.
*
- * 'twitter' => [
- * 'consumerkey' => '',
- * 'consumersecret' => '',
- * ],
+ * return [
+ * 'twitter' => [
+ * 'consumerkey' => '',
+ * 'consumersecret' => '',
+ * ],
+ * ];
*
* To activate the addon itself add it to the system.addon
* setting. After this, your user can configure their Twitter account settings
projects / friendica-addons.git / commitdiff