Initial commit.

2026-01-21 13:12:04 -05:00
commit 1e9e5a5925
190 changed files with 25707 additions and 0 deletions
@@ -0,0 +1,35 @@
+# Profile Editor
+
+In the profile editor you edit your public profile. Some of the things you add here will not be visible if the server software assumes that the connection is coming from a bot. So there is some protection to your email and other contact information if you add one here. 
+
+You can add a bio, which is a short explanation into who you are. The bio supports [markdown](/help?topic=markdown) formatting. This bio should not be longer than 10 thousand characters. 
+
+For fediverse and matrix accounts, the server will try to convert your link into a handle. In case of Mastodon, it assumes it is actually Mastodon and not Pleroma or Akkoma or something else. Therefor it might break links if you put an incompatible link into the handle.
+
+# Notifications
+
+On the right side of the page, you can find notifications that are personal to your profile.
+
+# Invites
+
+BDServer uses invites as a method to limit necessity of moderation. The way it works is very simple, from your settings page you can invite a person. You type that person's name and click "Invite". It will generate an invite code that this person now can use to register on the website. 
+
+Additionally it will also generate an invitation link, where no invitation code is necessary.
+
+# For Administrators
+
+If you are an administrator of the website ( meaning your rank is 0 ) you will see additional settings in your settings page. 
+
+## Federation
+
+As an administrator you can setup Federation with other instances of BDServer directly from your settings. This means you can add / remove / ban other websites from interacting with your website. And if you so desire you can enable automatic federation with any other website that would want to federate with yours.
+
+## Mastodon verification checkbox
+
+Mastodon has a feature that looks like the Ex-Twitter's checkbox, for verified users. Mastodon does it by cross referencing a personal website. BDServer knows what HTML tags to add to make it work. For you as an admin you need to do the following steps:
+
+ - Add this website as your website in your mastodon. Go to Preferences > Public Profile > Extra fields. And add this website into one of those fields.
+ - Add this mastodon account into mastodon field in the setting here on this website.
+ - Run the `python3 run.py --set --account` command in the BDServer directory on your server. To set this account as the "Main Account". Which will tell the server to take the mastodon data from this account and render a link to it in the pages, the way that is required for the verification step of Mastodon to work.
+ 
+