Skip to content

Commit

Permalink
[various] Remove config/addon.config.php in favor of per-addon config…
Browse files Browse the repository at this point in the history
…uration file
  • Loading branch information
MrPetovan committed Nov 20, 2022
1 parent 5b25b03 commit 46d4d0b
Show file tree
Hide file tree
Showing 29 changed files with 140 additions and 209 deletions.
10 changes: 6 additions & 4 deletions geonames/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion geonames/config/geonames.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
14 changes: 8 additions & 6 deletions gravatar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion gravatar/config/gravatar.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
22 changes: 12 additions & 10 deletions impressum/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
],
];
2 changes: 1 addition & 1 deletion impressum/config/impressum.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
36 changes: 1 addition & 35 deletions ldapauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion ldapauth/config/ldapauth.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
27 changes: 1 addition & 26 deletions ldapauth/ldapauth.php
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
17 changes: 9 additions & 8 deletions leistungsschutzrecht/README.md
Original file line number Diff line number Diff line change
@@ -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,
],
];
10 changes: 6 additions & 4 deletions libravatar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
2 changes: 1 addition & 1 deletion libravatar/config/libravatar.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
10 changes: 6 additions & 4 deletions mathjax/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
=====
Expand Down
18 changes: 10 additions & 8 deletions openstreetmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Please see provided `config/openstreetmap.php` file for explanation on the additional configuration keys.
2 changes: 1 addition & 1 deletion openstreetmap/config/openstreetmap.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
40 changes: 1 addition & 39 deletions phpmailer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: [email protected]
'smtp_from' => '',
],
The configuration options for this module are described in the `config/phpmailer.config.php` file.

License
=======
Expand Down
2 changes: 1 addition & 1 deletion phpmailer/config/phpmailer.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
18 changes: 10 additions & 8 deletions piwik/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------
Expand Down
2 changes: 1 addition & 1 deletion piwik/config/piwik.config.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?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' => [
Expand Down
Loading

0 comments on commit 46d4d0b

Please sign in to comment.