View Source Libmention.Supervisor (libmention v0.1.4)

Responsible for managing send and receive jobs.

Put this in your supervision tree to start the processes of sending and/or receiving webmentions.

opts = [
  outgoing: [],
  incoming: []
]

children = [
  ...,
  {Libmention.Supervisor, opts}
]

options

Options

A keyword list of options is accepted for configuring one or both of

  • incoming webmentions (See "Incoming Opts" section)
  • outgoing webmentions (See "Outgoing Opts" section)

incoming-opts

Incoming opts

outgoing-opts

Outgoing opts

If you desire to send webmentions from your site, an outgoing key should be configured which takes it's own keyword list of options.

outgoing: [
  user_agent: "",
  storage: Libmention.EtsStorage,
  proxy: [
    port: 8082,
    host: "localhost"
  ]
]

Options include:

  • user_agent - String - Customize the HTTP User Agent used when fetching the target URL. Defaults to "libmention-Webmention-Discovery"
  • storage - Module - The storage behaviour module to use when sending webmentions. Defaults to Libmention.EtsStorage. See Libmention.StorageApi for more options.
  • proxy - Keyword List - This is useful for local development only. If enabled, it starts a Plug application on the requested port proxy: [port: 8082] that all sent webmentions go to and shows a dashboard with their payloads. See Libmention.Outgoing.Proxy for a full explanation and other options available.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Starts a process that parses, validates and sends webmentions.

Link to this section Functions

Returns a specification to start this module under a supervisor.

See Supervisor.

Starts a process that parses, validates and sends webmentions.