Tumblr: Added support for hook "support_probe"

[friendica-addons.git] / public_server / README.md

diff --git a/public_server/README.md b/public_server/README.md
index 44b29f8e595bd37a41f1eb4f5edb97d417dc6fe2..082379c3347597a970c0a60e6bd5db85ecd3416e 100644 (file)
--- a/public_server/README.md
+++ b/public_server/README.md
@@ -2,28 +2,31 @@ Public Server
 =============
 
 
 =============
 
 

-Public Server is a Friendica plugin which implements automatic account & post expiration so that a site may be used as a public
-test bed with reduced data retention. 
+Public Server is a Friendica addon which implements automatic account & post expiration so that a site may be used as a public test bed with reduced data retention.

 
 

-This is a modified version of the testdrive plugin, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE PLUGIN.
+This is a modified version of the testdrive addon, DO NOT ACTIVATE AT THE SAME TIME AS THE TESTDRIVE ADDON.

 
 

-//When an account is created on the site, it is given a hard expiration date of 
-$a->config['public_server']['expiredays'] = 30;
-//Set the default days for posts to expire here
-$a->config['public_server']['expireposts'] = 30;
-//Remove users who have never logged in after nologin days
-$a->config['public_server']['nologin'] = 30;
-//Remove users who last logged in over flagusers days ago
-$a->config['public_server']['flagusers'] = 146;
-//For users who last logged in over flagposts days ago set post expiry days to flagpostsexpire
-$a->config['public_server']['flagposts'] = 90;
-$a->config['public_server']['flagpostsexpire'] = 146;
+       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 .htconfig.php file. By default nothing is defined in case the plugin 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.
 
 The expiration date is updated when the user logs in.
 
 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.
 
 The expiration date is updated when the user logs in.
 

-An email warning will be sent out approximately five days before the expiration occurs. Five days later the account is removed completely. 
-   
+An email warning will be sent out approximately five days before the expiration occurs.
+Five days later the account is removed completely.