diff --git a/_posts/2023-07-30-Server-Metadata.md b/_posts/2023-07-30-Server-Metadata.md new file mode 100644 index 000000000..7001806c9 --- /dev/null +++ b/_posts/2023-07-30-Server-Metadata.md @@ -0,0 +1,35 @@ +--- +layout: post +title: "Allow or block bots" +lang: "en" +heading: "Metadata for servers" +--- + +To provide information about Servers and specify policies for bots, a server owner can add metadata to their server welcome message. This page describes metadata a welcome message might include. + + + +You can add metadata to your server for many purposes. Adding contact information like the E-Mail or Website of the Server administrator helps users to contact the administrator if something goes wrong with the server. Also adding policies for bots allows them to judge if they can or cannot connect to the server. + +## How to add metadata + +Metadata should be added to the welcome message. If you are running a GUI server, paste the metadata into the welcome message box. Headless servers can use the `--welcomemessage` CLI argument to provide a path to a file containing the welcome message. + +## Format of metadata + +A metadata tag is a HTML comment that looks like this: + +```html + +``` + +For example, to add a way to contact the server administrator, a tag could look like this: + +```html + +``` + +You can modify and paste this into your welcome message. + +See [this discussion](https://github.com/orgs/jamulussoftware/discussions/3086) for more information. + diff --git a/wiki/en/Running-a-Server.md b/wiki/en/Running-a-Server.md index 62e126262..b13e86def 100644 --- a/wiki/en/Running-a-Server.md +++ b/wiki/en/Running-a-Server.md @@ -286,6 +286,12 @@ You can see the result of these commands if you run `systemctl status jamulus`, --- +## Adding metadata to the Server + +You can add metadata to the welcome message of a Server to add additional, hidden information like contact information or policy requests for bots (this is comparable to [robots.txt](https://en.wikipedia.org/wiki/Robots.txt)). See the [Community Knowledge Base entry about metadata](/kb/2023/07/30/Server-Metadata.html) for more information. + +--- + ## Servers on the desktop Jamulus can run in Server mode in the graphical environment of a computer. This gives you a graphical user interface to control most of the settings. To do this, first [install Jamulus for your platform](Getting-Started), then do one of the following: