octo/BirdsiteLive
1
0
Fork 0
mirror of https://github.com/NicolasConstant/BirdsiteLive synced 2025-06-05 21:49:16 +02:00
Code Issues Projects Releases Wiki Activity

Update VARIABLES documentation to use inclusive language

Browse Source
This commit is contained in:
prplecake
2022-10-01 14:04:16 -05:00
parent 8a451cb980
commit c5d5ed813a
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
VARIABLES.md
View File

@ -2,7 +2,7 @@
You can configure some of BirdsiteLIVE's settings via environment variables (those are optionnals): You can configure some of BirdsiteLIVE's settings via environment variables (those are optionnals):
## Blacklisting & Whitelisting ## Blocklisting & Allowlisting
### Fediverse users and instances ### Fediverse users and instances
@ -12,14 +12,14 @@ Here are the supported patterns to describe Fediverse users and/or instances:
* `instance.ext` to describe an instance under a domain name * `instance.ext` to describe an instance under a domain name
* `*.instance.ext` to describe instances from all subdomains of a domain name (this doesn't include the instance.ext, if you want both you need to add both) * `*.instance.ext` to describe instances from all subdomains of a domain name (this doesn't include the instance.ext, if you want both you need to add both)
You can whitelist or blacklist fediverses users by settings the followings variables with the above patterns separated by `;`: You can allowlist or blocklist fediverses users by settings the followings variables with the above patterns separated by `;`:
* `Moderation:FollowersWhiteListing` Fediverse Whitelisting * `Moderation:FollowersAllowListing` Fediverse Allowlisting
* `Moderation:FollowersBlackListing` Fediverse Blacklisting * `Moderation:FollowersBlockListing` Fediverse Blocklisting
If the whitelisting is set, only given patterns can follow twitter accounts on the instance. If the allowlisting is set, only given patterns can follow twitter accounts on the instance.
If blacklisted, the given patterns can't follow twitter accounts on the instance. If blocklisted, the given patterns can't follow twitter accounts on the instance.
If both whitelisting and blacklisting are set, only the whitelisting will be active. If both allowlisting and blocklisting are set, only the allowlisting will be active.
### Twitter users ### Twitter users
@ -27,14 +27,14 @@ Here is the supported pattern to describe Twitter users:
* `twitter_handle` to describe a Twitter user * `twitter_handle` to describe a Twitter user
You can whitelist or blacklist twitter users by settings the followings variables with the above pattern separated by `;`: You can allowlist or blocklist twitter users by settings the followings variables with the above pattern separated by `;`:
* `Moderation:TwitterAccountsWhiteListing` Twitter Whitelisting * `Moderation:TwitterAccountsAllowListing` Twitter Allowlisting
* `Moderation:TwitterAccountsBlackListing` Twitter Blacklisting * `Moderation:TwitterAccountsBlockListing` Twitter Blocklisting
If the whitelisting is set, only given patterns can be followed on the instance. If the allowlisting is set, only given patterns can be followed on the instance.
If blacklisted, the given patterns can't be followed on the instance. If blocklisted, the given patterns can't be followed on the instance.
If both whitelisting and blacklisting are set, only the whitelisting will be active. If both allowlisting and blocklisting are set, only the allowlisting will be active.
## Logging ## Logging
@ -76,8 +76,8 @@ services:
- Db:Password=birdsitelive - Db:Password=birdsitelive
- Twitter:ConsumerKey=twitter.api.key - Twitter:ConsumerKey=twitter.api.key
- Twitter:ConsumerSecret=twitter.api.key - Twitter:ConsumerSecret=twitter.api.key
+ - Moderation:FollowersWhiteListing=@me@my-instance.ca;friend-instance.com;*.friend-instance.com + - Moderation:FollowersAllowListing=@me@my-instance.ca;friend-instance.com;*.friend-instance.com
+ - Moderation:TwitterAccountsBlackListing=douchebag;jerk_88;theRealIdiot + - Moderation:TwitterAccountsBlockListing=douchebag;jerk_88;theRealIdiot
+ - Instance:Name=MyTwitterRelay + - Instance:Name=MyTwitterRelay
+ - Instance:ResolveMentionsInProfiles=false + - Instance:ResolveMentionsInProfiles=false
+ - Instance:PublishReplies=true + - Instance:PublishReplies=true
@ -85,7 +85,7 @@ services:
+ - Instance:SensitiveTwitterAccounts=archillect + - Instance:SensitiveTwitterAccounts=archillect
networks: networks:
[...] [...]
~~~~
db: db:
image: postgres:9.6 image: postgres:9.6
[...] [...]