Initial commit.

This commit is contained in:
2026-01-21 13:12:04 -05:00
commit 1e9e5a5925
190 changed files with 25707 additions and 0 deletions
+160
View File
@@ -0,0 +1,160 @@
# Markdown Text Formatting
This website is using a modified version of [markdown](https://en.wikipedia.org/wiki/Markdown) for posts and comments. Some regular features are not supported, while other features are added.
Markdown in useful to add style to the text.
For example here is a text that I will write in the editor:
```
# Header
Some normal text. *Some italic text.* More normal text.
## Second level header
Text with some **bold characters**. A [link to wikipedia.](https://wikipedia.org)
A separation line:
___________________________
And an image:
![Which even has an alt text](/icon/image)
or I can even nest an image into a link:
[![icon](/icon/link)](https://wikipedia.org)
> And of course a quote.
```
And this is what this text will look like in the page:
# Header
Some normal text. *Some italic text.* More normal text.
## Second level header
Text with some **bold characters**. A [link to wikipedia.](https://wikipedia.org)
A separation line:
___________________________
And an image:
![Which even contains an alt text](/icon/image)
or I can even nest an image into a link:
[![icon](/icon/link)](https://wikipedia.org)
> And of course a quote.
# Comments
Additionally it supports other things as well. Such as quoting a user:
```
@blenderdumbass
```
Adding a `@` symbol in front of a username will make a link to the user. And writing it in a comment will also notify the user.
```
c:0
```
Comments have codes to them such as `c:0` or `c:1` or other. You can make a blank line with a reference to a comment like this.
# Source code
To do little code snippets you can use the ``` on either side. Like this:
```
To do something to may want to run the `HelloWorld()` function.
```
Which will look like this:
_____
To do something to may want to run the `HelloWorld()` function.
_____
For multi-line code you can use ````` on either side. Make sure they are the only thing in the line:
```
Here is some code in python:
```
def HelloWorld():
print("Hello World")
HelloWorld()
```
```
It will render like this:
____
Here is some code in python:
```
def HelloWorld():
print("Hello World")
HelloWorld()
```
____
For more complex codes like when you want to show the ``` character itself, please use the [HTML escape codes](https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references#List_of_character_entity_references_in_HTML).
# Media Files
You can link a video or an audio file like this:
```
Big Buck Bunny:
![video](https://upload.wikimedia.org/wikipedia/commons/transcoded/c/c0/Big_Buck_Bunny_4K.webm/Big_Buck_Bunny_4K.webm.720p.vp9.webm)
The Free Software Song:
![audio](https://www.gnu.org/music/FreeSWSong.ogg)
Moria's Race:
![peertube-video](https://peer.madiator.cloud/w/vmPmME5XPWNc8uXSMe1xCk)
```
Which will look like this:
_____
Big Buck Bunny:
![video](https://upload.wikimedia.org/wikipedia/commons/transcoded/c/c0/Big_Buck_Bunny_4K.webm/Big_Buck_Bunny_4K.webm.720p.vp9.webm)
The Free Software Song:
![audio](https://www.gnu.org/music/FreeSWSong.ogg)
Moria's Race:
![peertube-video](https://peer.madiator.cloud/w/vmPmME5XPWNc8uXSMe1xCk)
# Icon Links
For user profiles it is useful to link many different social medias. And for that you can use icon links. Like so:
```
![mastodon](http://joinmastodon.org) ![peertube](https://joinpeertube.org)
```
Which will look like this:
____
![mastodon](http://joinmastodon.org) ![peertube](https://joinpeertube.org)
___
This uses the full list of icons that come with the software. The full list is available to see [here](https://codeberg.org/blenderdumbass/BDServer/src/branch/main/icons).
+19
View File
@@ -0,0 +1,19 @@
# Petitions
Petitions are useful to tell people that something is important. To engage people a bit more than surface level posts. All petitions have a certain goal that must be reached. And some way for people to "sign", as in, to help that goal to get reached.
Petitions will show a progress bar, telling the user how much of the goal is reached and how much is yet to be reached.
Often petitions will have some outcome when the goal is reached. Say a publication by the website's author will be published.
There are a few types of petitions:
## Regular Petition
With regular petitions a signature is recorded by email. The person who wants to sign it puts an email address into an email field and then is asked to check the email to confirm that the email belongs to the person. In this case, one email address equals one signature.
## Statistical Petitions
A Statistical Petition is a petition where a certain statistic is used for the amount of signatures. For example, a statistic could be [Mastodon](https://joinmastodon.org/) followers of a specific account. And so to sign that petition, one needs to follow that account.
Often those kinds of petitions are made with [Fediverse](https://en.wikipedia.org/wiki/Fediverse) Social Network statistics. That means that any one account on the Fediverse can effect statistics on other accounts on the Fediverse. Or in other words: If you have an account on Mastodon and the petition asks you to subscribe to [PeerTube](https://joinpeertube.org/), you can do that from your Mastodon account.
+35
View File
@@ -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.
+30
View File
@@ -0,0 +1,30 @@
# Subscribe and Share
Under every article you can see two buttons: "Subscribe RSS" and "Share on Mastodon". This page will give you some information about what those do.
# Subscribe RSS
[RSS](https://en.wikipedia.org/wiki/RSS) is a tool allowing people to subscribe to things on the internet without making accounts everywhere. There are various RSS Feed Readers that you can install that can get updates for you about new publications on websites.
On Mozilla [Firefox](https://firefox.com) there is a pretty neat extension called [Easy RSS](https://addons.mozilla.org/en-US/firefox/addon/easy-rss/) by Komodo.
If you don't want to use a browser extension, you can use something like [Gnome Feeds](https://gfeeds.gabmus.org/) or [Feed Reader](https://github.com/jangernert/FeedReader) instead.
For those that like everything to be in the terminal, you can use something like [Newsboat](https://newsboat.org/).
Usually providing a feed reader with the URL of the website is enough. But sometimes you may need to specify a direct path to the RSS itself. Clicking on "Subscribe RSS" will give you two direct RSS links:
The first one listing publications of the author of the post.
The second listing all publications on the website, from all authors.
# Share on Mastodon
[Mastodon](https://joinmastodon.org/) is a [Fediverse](https://en.wikipedia.org/wiki/Fediverse) platform designed to look and feel similarly to something like Ex-Twitter. The website allows you to share links from it directly to Mastodon, but before you can do that it will ask you what instance you are using.
If you don't have an account on Mastodon, you can make one by going to [joinmastodon.org](https://joinmastodon.org/), where instances will be suggested to you based on various things.
Mastodon, unlike conventional social media platforms, is not operated entirely by one company. But rather by many small communities that talk to each other all the time. This is called "Fediverse". So there is no single Mastodon website. You have many different ones called "Instances".
For example there is [mastodon.social](https://mastodon.social) and [mastodon.online](https://mastodon.online) and [mstdn.social](https://mstdn.social) and many, many others. Because of that, the website has no idea which of them is the one you have. So it kindly asks you to tell the instance before you press the share button.
When you do press the share button, it will redirect you to a page on your Mastodon instance, where you will be presented with a suggestion of how to word the post. You can edit that if you want to and press "Post" to finish sharing.