Watcher's Eye

One by one, they stood their ground against a creature they had no hope of understanding, let alone defeating, and one by one, they became a part of it.

Watcher's Eye is a social network post surveillance tool.

How to use

Create the following configurations.

• config/global.yml

collector_processes: auto

• config/credentials.yml

mastodon_sample_creds: &mastodon_sample_creds
  token: xxxx

twitter_sample_creds: &twitter_sample_creds
  consumer_key: xxxx
  consumer_secret: xxxx
  access_token: xxxx
  access_token_secret: xxxx

• config/targets/sample.yml

- kind: mastodon
  label: sample_user
  domain: example.com
  acct: [email protected]
  credentials: *mastodon_sample_creds

• config/publishers/sample.yml

- kind: discord
  label: discord_sample
  targets:
  - sample_user
  webhook_url: https://discord.com/api/webhooks/xxxx

Then, run the Docker Container

docker-compose build
docker-compose run --rm app carton install --deployment
docker-compose up -d

Configuration details

collector_processes

Specify the number of Collector processes to run in multiprocesses.

• auto: Use the nproc command to automatically set the maximum number of processors.

targets

Define the target to be surveilled.

kind

Specifies the type of service to which the surveilling target belongs.
Currently, Watcher's Eye supports the following three services.

• mastodon
• mastodon_rest
• misskey
• twitter
• twitter_v2

label

Assign a label to the surveilled object.
This label will be used by Publisher.

domain

Specify the domain of the user who has the obtained API key. (i.e. you)
Note that this is not the domain to be surveilled.

acct (Other than Twitter)

Specifies the acct to be surveilled.

account_id

Specifies the account ID to be surveilled.
Note that it is not the Screen Name. In the case of Mastodon, it is only used in the REST API.

credentials

Describe the Credentials for accessing the API.
Use the correct key for each service.

• Mastodon, Misskey

  credentials:
    token: xxxxxxxxxxxxxxxxxxxxxxxx

• Twitter

  credentials:
    consumer_key: xxxx
    consumer_secret: xxxx
    access_token: xxxx
    access_token_secret: xxxx

private_only

When enabled, only posts with Visibility equivalent to Private will be retrieved.
This is not available for Twitter.

use_tor

Experimental.

publishers

Defines the forwarding destination for retrieved posts.

kind

Specify the type of service to be forwarded.
Currently, Watcher's Eye supports the following two services.

• discord
• slack

label

Unlike the label of targets, there is no specific use for it.

targets

Specifies the surveilling targets defined in the targets section in list format.

webhook_url

Specify the URL of Incoming Webhook that matches the kind.