mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-10-28 06:22:26 -05:00
[docs] clearer structure for "combining blocks and allows" section (#4065)
# Description This patch moves figures around in `admin/federation_modes.md` in order to make the text more approachable. Reading it, I found that I dwelled long on the chart, not thinking that there would be an easier to read explanation below, so I thought it'd make sense to swap the places. I also felt like the warning at the bottom was important enough that it'd better be up near the top of the section, highlighting the importance of understanding the explanation below. I did not see a commit message style guide in project docs so I improvised based on recent commit messages ## Checklist Please put an x inside each checkbox to indicate that you've read and followed it: `[ ]` -> `[x]` If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want). - [X] I/we have read the [GoToSocial contribution guidelines](https://codeberg.org/superseriousbusiness/gotosocial/src/branch/main/CONTRIBUTING.md). - [ ] I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat. - [X] I/we have not leveraged AI to create the proposed changes. - [ ] I/we have performed a self-review of added code. - [ ] I/we have written code that is legible and maintainable by others. - [ ] I/we have commented the added code, particularly in hard-to-understand areas. - [ ] I/we have made any necessary changes to documentation. - [ ] I/we have added tests that cover new code. - [ ] I/we have run tests and they pass locally with the changes. - [ ] I/we have run `go fmt ./...` and `golangci-lint run`. Reviewed-on: https://codeberg.org/superseriousbusiness/gotosocial/pulls/4065 Co-authored-by: İ. Göktuğ Kayaalp <self@gkayaalp.com> Co-committed-by: İ. Göktuğ Kayaalp <self@gkayaalp.com>
This commit is contained in:
parent
d5c3f44bb9
commit
d3e9a9e563
1 changed files with 10 additions and 10 deletions
|
|
@ -31,13 +31,18 @@ When your instance encounters a mention or an announce of a status or account it
|
|||
|
||||
## Combining blocks and allows
|
||||
|
||||
It is possible to both block and allow the same domain, and the effect of combining these two things depends on which federation mode your instance is currently using.
|
||||
!!! danger
|
||||
Combining blocks and allows is a tricky business!
|
||||
|
||||
When importing lists of allows and blocks, you should always review the list manually to make sure that you do not inadvertently block a domain that you would prefer not to block, since this can have **very annoying side effects** like removing follows/following, statuses, etc.
|
||||
|
||||
When in doubt, always add an explicit allow first as an insurance policy!
|
||||
|
||||

|
||||
It is possible to both block and allow the same domain, and the effect of combining these two things depends on which federation mode your instance is currently using, as explained in the following subsections, which are summarised in a flowchart that you can find below.
|
||||
|
||||
### In blocklist mode
|
||||
|
||||
As the chart shows, in blocklist mode (the left-hand part of the diagram), an explicit domain allow can be used to override a domain block.
|
||||
As the chart below shows, in blocklist mode (the left-hand part of the diagram), an explicit domain allow can be used to override a domain block.
|
||||
|
||||
This is useful in cases where you are importing a blocklist from someone else, but the imported blocklist contains some instances you would actually prefer not to block. To avoid blocking those instances, you can create explicit domain allows for those instances first. Then, when you import the block list, the explicitly allowed domains will not be blocked, and the side effects of creating a block (deleting statuses, media, relationships etc) will not be processed.
|
||||
|
||||
|
|
@ -47,16 +52,11 @@ Conversely, if you add an explicit allow for a domain that was blocked, the side
|
|||
|
||||
### In allowlist mode
|
||||
|
||||
As the chart shows, in allowlist mode (the right-hand part of the diagram) an explicit domain block trumps an explicit domain allow. The following two things must be true in order for an instance to be allowed through, when running in allowlist mode:
|
||||
As the chart below shows, in allowlist mode (the right-hand part of the diagram) an explicit domain block trumps an explicit domain allow. The following two things must be true in order for an instance to be allowed through, when running in allowlist mode:
|
||||
|
||||
1. An explicit domain block **does not exist** for the instance.
|
||||
2. An explicit domain allow **does exist** for the instance.
|
||||
|
||||
If either of the above conditions are not met, the request will be denied.
|
||||
|
||||
!!! danger
|
||||
Combining blocks and allows is a tricky business!
|
||||
|
||||
When importing lists of allows and blocks, you should always review the list manually to make sure that you do not inadvertently block a domain that you would prefer not to block, since this can have **very annoying side effects** like removing follows/following, statuses, etc.
|
||||
|
||||
When in doubt, always add an explicit allow first as an insurance policy!
|
||||

|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue