From 12873db070b3aa099a704d56bd3069b61dac6e9b Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Fri, 4 Oct 2019 13:56:25 +0100 Subject: [PATCH] Update readme for groups --- README_commandline.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README_commandline.md b/README_commandline.md index 756f5621..3335cae3 100644 --- a/README_commandline.md +++ b/README_commandline.md @@ -34,6 +34,24 @@ To set the background image for an account: python3 epicyon.py --nickname [nick] --domain [name] --background [image filename] ``` +## Groups + +Groups are a special type of account which relays any posts sent to it to its members (followers). + +To create a group: + +``` bash +python3 epicyon.py --addgroup nickname@domain --password [yourpassword] +``` + +To remove an account (be careful!): + +``` bash +python3 epicyon.py --rmgroup nickname@domain +``` + +Setting avatar or changing background is the same as for any other account on the system. You can also moderate a group, applying filters, blocks or a perimeter, in the same way as for other acounts. + ## Defining a perimeter By default the server will federate with any others, but there may be cases where you want to limit this down to a defined set of servers within an organization.