Browse Source

Add README

master
Chimo 2 years ago
parent
commit
c05682c85e
1 changed files with 27 additions and 0 deletions
  1. 27
    0
      README.md

+ 27
- 0
README.md View File

@@ -0,0 +1,27 @@
1
+# List inactive accounts on a GNU social instance
2
+
3
+## Installation
4
+
5
+1. Navigate to your `/local/plugins` directory
6
+1. `git clone https://github.com/chimo/gs-staleAccounts.git StaleAccounts`
7
+
8
+Tell `/config.php` to use it with:
9
+
10
+```php
11
+addPlugin('StaleAccounts');
12
+```
13
+
14
+## Configuration
15
+
16
+By default, accounts are considered stale/inactive after 3 months of inactivity.
17
+To change this to a different number of months, you can use the following:
18
+
19
+```php
20
+$config['staleaccounts']['inactive_period'] = 12; // A year
21
+```
22
+
23
+## Usage
24
+
25
+Instance administrators should see a "Stale Accounts" link in the left-navigation
26
+of the "Admin" section (https://example.org/panel/staleaccounts)
27
+

Loading…
Cancel
Save