From: Hypolite Petovan Date: Sun, 20 Nov 2022 16:43:42 +0000 (-0500) Subject: [various] Remove config/addon.config.php in favor of per-addon configuration file X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=46d4d0b51ee0d08b40edc8389c847f35a317dc01;p=friendica-addons.git [various] Remove config/addon.config.php in favor of per-addon configuration file --- diff --git a/geonames/README.md b/geonames/README.md index 16b85b37..7673840d 100644 --- a/geonames/README.md +++ b/geonames/README.md @@ -7,10 +7,12 @@ Use [Geonames service](https://www.geonames.org) to resolve nearest populated lo ## 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. diff --git a/geonames/config/geonames.config.php b/geonames/config/geonames.config.php index 6af3634e..179fb56c 100644 --- a/geonames/config/geonames.config.php +++ b/geonames/config/geonames.config.php @@ -1,7 +1,7 @@ [ diff --git a/gravatar/README.md b/gravatar/README.md index 02b9bfd2..1a71a4d3 100644 --- a/gravatar/README.md +++ b/gravatar/README.md @@ -38,11 +38,13 @@ Open the `config/local.config.php` file and add "gravatar" to the list of activa ... ] -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" diff --git a/gravatar/config/gravatar.config.php b/gravatar/config/gravatar.config.php index 75bab4fc..2a399d93 100644 --- a/gravatar/config/gravatar.config.php +++ b/gravatar/config/gravatar.config.php @@ -1,7 +1,7 @@ [ diff --git a/impressum/README.md b/impressum/README.md index ca78d9a0..52034008 100644 --- a/impressum/README.md +++ b/impressum/README.md @@ -16,14 +16,16 @@ Simply fill in the fields in the impressium settings page in the addons area of 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. + ], + ]; diff --git a/impressum/config/impressum.config.php b/impressum/config/impressum.config.php index 9fe672fc..b4de4f37 100644 --- a/impressum/config/impressum.config.php +++ b/impressum/config/impressum.config.php @@ -1,7 +1,7 @@ [ diff --git a/ldapauth/README.md b/ldapauth/README.md index f37bb9d5..dc0b49c7 100644 --- a/ldapauth/README.md +++ b/ldapauth/README.md @@ -12,38 +12,4 @@ However, it's possible with an option to automate the creation of a Friendica ba 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. diff --git a/ldapauth/config/ldapauth.config.php b/ldapauth/config/ldapauth.config.php index e89a2b55..2a79b34c 100644 --- a/ldapauth/config/ldapauth.config.php +++ b/ldapauth/config/ldapauth.config.php @@ -1,7 +1,7 @@ [ diff --git a/ldapauth/ldapauth.php b/ldapauth/ldapauth.php index 72e140e7..2935c74a 100644 --- a/ldapauth/ldapauth.php +++ b/ldapauth/ldapauth.php @@ -26,32 +26,7 @@ * 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; diff --git a/leistungsschutzrecht/README.md b/leistungsschutzrecht/README.md index 7026af53..18bc9c4f 100644 --- a/leistungsschutzrecht/README.md +++ b/leistungsschutzrecht/README.md @@ -1,16 +1,17 @@ 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, + ], + ]; diff --git a/libravatar/README.md b/libravatar/README.md index bcc0f824..fc06feab 100644 --- a/libravatar/README.md +++ b/libravatar/README.md @@ -31,10 +31,12 @@ Open the `config/local.config.php` file and add "libravatar" to the list of acti ... ] -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" diff --git a/libravatar/config/libravatar.config.php b/libravatar/config/libravatar.config.php index 7f4f50f6..a59a74ec 100644 --- a/libravatar/config/libravatar.config.php +++ b/libravatar/config/libravatar.config.php @@ -1,7 +1,7 @@ [ diff --git a/mathjax/README.md b/mathjax/README.md index f5a0388f..e907fadf 100644 --- a/mathjax/README.md +++ b/mathjax/README.md @@ -29,11 +29,13 @@ the addon by adding _mathjax_ to the list in your `config/local.config.php` file ... ] -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 ===== diff --git a/openstreetmap/README.md b/openstreetmap/README.md index d8709a18..78c74800 100644 --- a/openstreetmap/README.md +++ b/openstreetmap/README.md @@ -42,18 +42,20 @@ Open the `config/local.config.php` file and add "openstreetmap" to the list of a ... ] -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. diff --git a/openstreetmap/config/openstreetmap.config.php b/openstreetmap/config/openstreetmap.config.php index e9252ca5..c649da5f 100644 --- a/openstreetmap/config/openstreetmap.config.php +++ b/openstreetmap/config/openstreetmap.config.php @@ -1,7 +1,7 @@ [ diff --git a/phpmailer/README.md b/phpmailer/README.md index c51405f4..23ce75c0 100644 --- a/phpmailer/README.md +++ b/phpmailer/README.md @@ -8,45 +8,7 @@ This addon replaces the default `mail()` function by the `PHPMailer` library, al 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 ======= diff --git a/phpmailer/config/phpmailer.config.php b/phpmailer/config/phpmailer.config.php index b2916471..4b084da7 100644 --- a/phpmailer/config/phpmailer.config.php +++ b/phpmailer/config/phpmailer.config.php @@ -1,7 +1,7 @@ [ diff --git a/piwik/README.md b/piwik/README.md index 0878394e..c336fc79 100644 --- a/piwik/README.md +++ b/piwik/README.md @@ -30,14 +30,16 @@ Open the `config/local.config.php` file and add "piwik" to the list of activated ... ] -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 --------------------- diff --git a/piwik/config/piwik.config.php b/piwik/config/piwik.config.php index 7543097c..ba59b63d 100644 --- a/piwik/config/piwik.config.php +++ b/piwik/config/piwik.config.php @@ -1,7 +1,7 @@ [ diff --git a/piwik/piwik.php b/piwik/piwik.php index a73ee96b..047e41a3 100644 --- a/piwik/piwik.php +++ b/piwik/piwik.php @@ -16,14 +16,17 @@ * * 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 @@ -60,7 +63,7 @@ function piwik_analytics(App $a, string &$b) DI::page()['htmlhead'] .= ''; /* - * 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'); diff --git a/public_server/README.md b/public_server/README.md index fecc38ba..082379c3 100644 --- a/public_server/README.md +++ b/public_server/README.md @@ -6,21 +6,23 @@ Public Server is a Friendica addon which implements automatic account & post exp 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. diff --git a/public_server/config/public_server.config.php b/public_server/config/public_server.config.php index 47ad4107..6315cc93 100644 --- a/public_server/config/public_server.config.php +++ b/public_server/config/public_server.config.php @@ -1,7 +1,7 @@ [ diff --git a/pumpio/README.md b/pumpio/README.md index 33137984..ab53a300 100644 --- a/pumpio/README.md +++ b/pumpio/README.md @@ -1,11 +1,13 @@ -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. diff --git a/pumpio/config/pumpio.config.php b/pumpio/config/pumpio.config.php index 4f3dc460..e2c5b726 100644 --- a/pumpio/config/pumpio.config.php +++ b/pumpio/config/pumpio.config.php @@ -1,7 +1,7 @@ [ diff --git a/testdrive/README.md b/testdrive/README.md index 59512aef..675f64e2 100644 --- a/testdrive/README.md +++ b/testdrive/README.md @@ -6,12 +6,14 @@ Testdrive is a Friendica addon which implements automatic account expiration so 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. diff --git a/testdrive/config/testdrive.config.php b/testdrive/config/testdrive.config.php index c10acf82..f4b1dc0f 100644 --- a/testdrive/config/testdrive.config.php +++ b/testdrive/config/testdrive.config.php @@ -1,7 +1,7 @@ [ diff --git a/twitter/README.md b/twitter/README.md index f1f87541..2efdddca 100644 --- a/twitter/README.md +++ b/twitter/README.md @@ -24,12 +24,14 @@ Open the `config/local.config.php` file and add "twitter" to the list of activat ... ] -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". diff --git a/twitter/config/twitter.config.php b/twitter/config/twitter.config.php index e39de2f9..8895814d 100644 --- a/twitter/config/twitter.config.php +++ b/twitter/config/twitter.config.php @@ -1,7 +1,7 @@ [ diff --git a/twitter/twitter.php b/twitter/twitter.php index 80ac14a6..99985d97 100644 --- a/twitter/twitter.php +++ b/twitter/twitter.php @@ -48,12 +48,14 @@ * 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