Open Docs Navigation

Managing Your Federation

As a federation owner, you have several options available to you to manage your federation. This page of the guide will walk you through these options. All the options listed on this page are only available to federation owners.

Federation Admins

One of the most important tasks you'll do as a federation owner is manage your admins. Unlike in a Telegram group, only the federation owner can assign new admins, which means anyone you assign as an admin will not be able to add new admins on your behalf.

Adding Federation Admins

To add an admin to your federation, you can issue the below command:

/fedpromote <@username or UserID>

You can also reply to any of the user's messages and issue the command without arguments, like shown below:

/fedpromote

Removing Federation Admins

To remove an admin from your federation, issue the following command:

/feddemote <@username or UserID>

Like adding an admin, you can also reply to any of the admin's messages and issue the command without any arguments, like below:

/feddemote

Federation Notifications

Whenever a federation action occurs (such as a ban or unban), Rose can notify the federation owner via PM every time a federation action occurs. This allows you to keep track of what your fed admins are doing.

Enable Federation Notifications

To enable federation notifications, issue either of the below commands:

/fednotif on
/fednotif yes

Disable Federation Notificatons

If you do not want to disable federation notifications, issue either of the following commands:

/fednotif off
/fednotif no

Federation Logging

This feature is similar to fedeation notificatons, except that you can use this feature to log your federation actions to one of your group chats or a channel, instead of via PM. This works similarly to the ADMIN LOGGING feature from the BASICS section, except that this log tracks federation admin actions only.

Enable Federation Logging

To enable federation logging, simply issue the below command in the group chat or channel where you want the logged actions to be sent:

/setfedlog

The group chat or channel will then be sent any actions performed in the federation.

Disable Federation Logging

If you no longer want to log your federation's actions, you can send a PM to Rose with the below command:

/unsetfedlog

Your federation's actions will no longer be logged to a group chat or channel.

Federation Ban Lists

Rose provides you with some options to view/export your federation's banlist to make a personal backup, as well as importing a banlist from another federation into yours.

Viewing/Exporting Your Federation's Ban List

If you wish to view a list of all of the banned users in your federation, you may issue the following command:

/fbanlist

Rose will then send a message containing a document named “fbanned_users.csv”. If you wish to output the document in a specific format, you can issue the command with the arguments below:

/fbanlist csv
/fbanlist json

CSV and JSON file formats are exactly what their name implies. You can search Google for more information on CSV and JSON files, as they are well-known data standards.

Importing Bans From A Ban List File

If you want to import bans into your federation from a ban list file, will first need to send Rose a message with your ban list attached as either a .csv or .json file. You will then need to reply to the message with the following command:

/importfbans

Rose will then process the document, and if there are no errors, she will import the bans in your banlist file. Please be aware of the below formatting requirements for importing bans:

  • CSV Files - The first row of your CSV must be id,firstname,lastname,username,reason. The subsequent rows will need to match. If you are manually adding values, each row must contain at least the “id”. Other fields may be left blank at your discretion.
  • JSON Files - For JSON files, your key-value pairings can be in any order. However, you must have the following keys present:
    • user_id, first_name, last_name, user_name, reason
    • Only “user_id” requires a value, all other keys you may denote blank values with "”
    • Unlike a typical JSON file, Rose's fedban list must be one JSON for each line, and not one large JSON.

Click on the link(s) below to download an example of each file:

CSV Example
JSON Example

Federation Subscriptions

Subscriptions allow your federation to “subscribe” to another fed's banlist. Let's look at a potential scenario:

  • Your fed currently has 3 chats joined to it
  • You want your chats to continue being part of your fed, but you also want to use the bans that have been performed in the “Rose Support Official” fed
  • By using subscriptions, you can subscribe your fed to the “Rose Support Official” fed, and Rose will ban any users in your chats that have been banned from the “Rose Support Official” federation.

Subscribing To A Federation

To subscribe your federation to another federation, issue the below command:

/subfed <FedID>

Example Scenario

If you wanted to subscribe your fed to the “Rose Support Official” fed, you would issue the following command:

/subfed 86718661-6bfc-4bd0-9447-7c419eb08e69

Unsubscribing From A Federation

There are times you may wish to longer enforce bans from a subscribed federation, or maybe you've reached the 5 federation limit for subscriptions and need to remove a subscribed fed in order to subscribe to a new one. To do this, issue the below command:

/unsubfed <FedID>

Example Scenario

If you wanted to unsubscribe your fed from the “Rose Support Official” fed, you would issue the following command:

/unsubfed 86718661-6bfc-4bd0-9447-7c419eb08e69

Viewing Your Federation's Subscriptions

If at any time you wish to see which federations your federation is currently subscribed to, you can issue the below command:

/fedsubs