prosody-modules
d194d1012fd3
mod_roster_command/README.markdown
Software / code / prosody-modules
File
mod_roster_command/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
| author | Ben Smith <bens@effortlessis.com> |
|---|---|
| date | Mon, 13 May 2024 13:25:13 -0700 |
| parent | 1820:8de50be756e5 |
line wrap: on
line source
--- labels: - 'Stage-Beta' summary: Manage rosters through prosodyctl ... Introduction ------------ This module allows you to perform various actions on user rosters via prosodyctl. Details ------- After putting this module in your modules directory you can use it via prosodyctl like this: prosodyctl mod_roster_command COMMAND [OPTIONS...] **Note:** Do not add mod\_roster\_command to your Prosody config file. This is unnecessary because it will automatically be loaded by prosodyctl when you use it. ### Commands subscribe user@host contact@host Subscribes the user to the contact's presence. That is, the user will see when the contact is online (but the contact won't see the user). subscribe_both user@host contact@host The same as the 'subscribe' command, but performs the subscription in both directions, so that both the contact and user will always see each other online. unsubscribe user@host contact@host Removes a subscription to the contact's presence. unsubscribe_both user@host contact@host Same as unsubscribe, but also revokes a contact's subscription to the user's presence. rename user@host contact@host [name] [group] Sets or updates a name for a contact in the user's roster, and moves the contact to the given group, if specified. Compatibility ------------- ----- ------- 0.9 Works 0.8 Works ----- -------
