Merge pull request #895 from annando/tumblr-https
[friendica-addons.git/.git] / impressum / README.md
1 Impressum Addon for Friendica
2 ==============================
3
4 * Author: Tobias Diekershoff
5 * License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license (see the LICENSE file in the addon directory)
6
7 About
8 -----
9 This addon adds an Impressum (contact) block to the /friendica page with informations about the page operator/owner and how to contact you in case of any questions.
10
11 In the notes and postal fields you can use bbcode tags for formatting, like in normal friendica postings..
12
13 Configuration
14 -------------
15 Simply fill in the fields in the impressium settings page in the addons area of your admin panel. For email adresses the "@" symbol will be obfuscated in the source of the page to make in harder for harvesting tools.
16
17 Manual Configuration
18 --------------------
19 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
20
21         'impressum' => [
22         'owner' => '',           This is the Name of the Operator
23         'ownerprofile' => '',    This is an optional Friendica account where the above owner name will link to
24         'email' => '',           A contact email address (optional)
25                                  Will be displayed slightly obfuscated as name(at)example(dot)com
26         'postal' => '',          Should contain a postal address where you can be reached at (optional)
27         'notes' => '',           Additional informations that should be displayed in the Impressum block
28         'footer_text' => '',     Text that will be displayed at the bottom of the pages.
29     ],