README.md 756 Bytes
Newer Older
Chocobozzz's avatar
Chocobozzz committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Auto mute plugin for PeerTube

Auto mute accounts or instances based on public blocklists.

## Format

This plugins expect the following JSON format from public blocklists:

```
{
  data: {
    value: string
    action?: 'add' | 'remove' // Default is 'add'
  }[]
}
```

For example:

```
Chocobozzz's avatar
Chocobozzz committed
21
22
23
24
25
26
27
28
29
30
{
  data: [
    {
      value: 'peertube.cpy.re'
    },
    {
      value: 'root@peertube.cpy.re'
    }
  ]
}
Chocobozzz's avatar
Chocobozzz committed
31
32
33
34
35
36
37
```

This plugin does not apply a diff, so if you want to remove an entity from the blocklist, add `action: 'remove'` to the object.

For example, to revert `peertube.cpy.re` from the blocklist, update the JSON:

```
Chocobozzz's avatar
Chocobozzz committed
38
39
40
41
42
43
44
45
46
47
48
49
{
  data: [
    {
      value: 'peertube.cpy.re',
      action: 'remove'
    },
    {
      value: 'root@peertube.cpy.re'
    }
  ]
}
```