Add allow-list documentation

This commit is contained in:
Ciaran Ainsworth 2022-01-20 20:07:21 +01:00 committed by Ciarán Ainsworth
parent d50b3dba6d
commit 12fb621949
4 changed files with 113 additions and 0 deletions

View File

@ -48,6 +48,7 @@ moderator_documentation/index
moderator_documentation/reports/index
moderator_documentation/domains/index
moderator_documentation/users/index
moderator_documentation/allow_listing/index
```

View File

@ -0,0 +1,67 @@
# Add a domain to your allow-list
If you have allow-listing enabled, you need to add a domain to your allow-list to interact with it. You can add new domains in two ways:
```{contents}
:local:
```
## Add a new domain
To add a domain that is not currently in your domains list:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
6. Check ({fa}`check-square`) the checkbox labeled {guilabel}`Add to allow-list`.
7. Select {guilabel}`Add`.
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
6. Check ({fa}`check-square`) the checkbox labeled {guilabel}`Add to allow-list`.
7. Select {guilabel}`Add`.
```
That's it! You've added the domain to your pod's allow-list.
## Add a known domain
To add a domain that is already in your pod's domain list:
```{tabbed} Desktop
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Check ({fa}`check-square`) the checkbox next to the domain(s) you want to add to the allow-list.
6. Select {guilabel}`Add to allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A green tick ({fa}`check`) appears next to the domain(s)
```
```{tabbed} Mobile
1. Log in to your {term}`pod`.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Check ({fa}`check-square`) the checkbox next to the domain(s) you want to add to the allow-list.
6. Select {guilabel}`Add to allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`. A green tick ({fa}`check`) appears next to the domain(s)
```
You're done! You've added the domain to your pod's allow-list.

View File

@ -0,0 +1,16 @@
# Allow-listing
By default, Funkwhale communicates with all reachable pods on the {term}`Fediverse`. If you want to lock down which pods you interact with, your pod admin can enable __allow-listing__. With this enabled, only pods on your allow-list can interact with your pod.
If you didn't use allow-listing before, you can remove all content from pods not on your list. Check out our guide on [purging content](../domains/purge_domain.md) to remove this content.
```{toctree}
---
caption: Manage your pod's allow-list
maxdepth: 1
---
add_domain
remove_domain
```

View File

@ -0,0 +1,29 @@
# Remove a domain from your allow-list
You can remove a domain from your {term}`pod's <Pod>` allow-list to stop communicating with it. To do this:
```{tabbed} Desktop
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Check ({fa}`check-square`) the checkbox next to the domain(s) you want to add to the allow-list.
6. Select {guilabel}`Remove from allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`.
```
```{tabbed} Mobile
1. Log in to your pod.
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
5. Check ({fa}`check-square`) the checkbox next to the domain(s) you want to add to the allow-list.
6. Select {guilabel}`Remove from allow-list` in the {guilabel}`Actions` dropdown.
7. Select {guilabel}`Go`.
```
You're done! You've removed the domain from your pod's allow-list.