machinery v0.8.0 Machinery.Plug View Source

This Plug module is the entry point for the Machinery Dashboard. It’s supposed to be used on the Endpoint of a Phoenix application, and it’s responsible to call the Machinery.Endpoint.

You’re expected to use this as a plug on the main application, and it also accepts an optional parameter that is the path you want to mount the Machinery dashboard if it’s other than /machinery.

Parameters

  • path: A string with the path you want to mount the dashboard if other than /machinery.

Example

  defmodule YourProject.Endpoint do
    plug Machinery.Plug
  end

Link to this section Summary

Functions

call/2 Intercepts the request as a plug and check if it matches with the defined path passed as argument, if it does it moves on calling the process/2 that will prepare the request and pass it through the Machinery.Endpoint

Function responsible for redirect the request to Machinery.Endpoint

Link to this section Functions

call/2 Intercepts the request as a plug and check if it matches with the defined path passed as argument, if it does it moves on calling the process/2 that will prepare the request and pass it through the Machinery.Endpoint.

Function responsible for redirect the request to Machinery.Endpoint.