Skip to content

02 2. Control domain

Jump to bottom
Naoki Kosaka edited this page Mar 2, 2023 · 3 revisions

Control Activity-Relay

domain command

domain command has management for subscriber.

$ relay control domain
List all subscriber, set/unset domain as limited or blocked and undo subscribe domain.

Usage:
   control domain [command]

Available Commands:
  list        List domain
  set         Set domain as limited or blocked
  unfollow    Send Unfollow request for provided domains
  unset       Unset domain as limited or blocked

Flags:
  -h, --help   help for domain

Global Flags:
  -c, --config string   Path of config (default "config.yml")
  -v, --verbose         Show debug log

Use " control domain [command] --help" for more information about a command.

list command

Lists currently subscriber / limited / blocked domains.

$ relay control domain list
List domain which filtered provided type.

Usage:
   control domain list [flags]

Flags:
  -h, --help          help for list
  -t, --type string   domain type [subscriber,limited,blocked] (default "subscriber")

Global Flags:
  -c, --config string   Path of config (default "config.yml")
  -v, --verbose         Show debug log

Example

  • List all subscribers.

    $ relay control domain list

  • List all blocked domains.

    $ relay control domain list -t blocked

set command

Register limited / blocked domain.

$ relay domain set
Set domain as limited or blocked.

Usage:
   control domain set [flags]

Flags:
  -h, --help          help for set
  -t, --type string   Apply domain type [limited,blocked]

Global Flags:
  -c, --config string   Path of config (default "config.yml")
  -v, --verbose         Show debug log

Tips: What is limited / blocked domain?

  • limited domain

    Statuses that sent from limited domain are not forward to other servers. So, this suitable usage is for server that to send Immoral status.

  • blocked domain

    Relay do not accept follow request for server registered as blocked domain. It can not use any feature with relay.

Example

  • Register example.com as blocked domain.

    $ relay domain set -t blocked example.com

  • Register example.com as limited domain.

    $ relay domain set -t limited example.com

unset command

Unregister limited / blocked domain.

$ relay domain unset
Unset domain as limited or blocked.

Usage:
   control domain unset [flags]

Flags:
  -h, --help          help for unset
  -t, --type string   Apply domain type [limited,blocked]

Global Flags:
  -c, --config string   Path of config (default "config.yml")
  -v, --verbose         Show debug log

Example

  • Unregister example.com as blocked domain.

    $ relay domain unset -t blocked example.com

  • Unregister example.com as limited domain.

    $ relay domain unset -t limited example.com

unfollow command

Relay send unfollow request to subscriber/follower. This usually use after register in blocked domain.

$ relay domain unfollow
Send unfollow request for provided domains.

Usage:
   control domain unfollow [flags]

Flags:
  -h, --help   help for unfollow

Global Flags:
  -c, --config string   Path of config (default "config.yml")
  -v, --verbose         Show debug log
Clone this wiki locally