View Source Agent Quick Install
introduction
Introduction
This is a concise list of steps to install the Paraxial.io agent. It is intended for users who have already read the agent guide.
1-mix-install
1. Mix install
{:paraxial, "~> 0.0.4"}
2-config
2. Config
config :paraxial,
paraxial_api_key: System.get_env("PARAXIAL_API_KEY"),
paraxial_url: "https://app.paraxial.io",
fetch_cloud_ips: true,
bulk: %{email: %{trusted: 100, untrusted: 3}},
trusted_domains: MapSet.new(["paraxial.io", "blackcatprojects.xyz"])
3-edit-endpoint-ex
3. Edit endpoint.ex
plug RemoteIp
plug Paraxial.AllowedPlug
plug Paraxial.RecordPlug
plug HavanaWeb.Router
plug Paraxial.RecordPlug
4-optional-to-send-current-user-edit-router-ex-add-paraxial-currentuserplug
4. (Optional) To send current user, edit router.ex
, add Paraxial.CurrentUserPlug
defmodule HavanaWeb.Router do
...
pipeline :browser do
...
plug Paraxial.CurrentUserPlug
end
Note: Only works with assign(conn, :paraxial_current_user, conn.assigns.current_user.email)
5-optional-send-paraxial_login_user_name-via-assigns
5. (Optional) Send :paraxial_login_user_name
via assigns
In your application code, determine how a user's login attempt flows through the code. You are looking for the line right before the user's provided email and password are checked against the database. Once you find that location, re-write the conn with:
conn = assign(conn, :paraxial_login_user_name, email)
Where email
is the user provided string for a login attempt.
6-optional-send-login-success-true-or-false
6. (Optional) Send login success true or false
conn = assign(conn, :paraxial_login_success, false)
7-optional-use-the-paraxial-bulk_allowed-3-function
7. (Optional) Use the Paraxial.bulk_allowed?/3
function
In your Paraxial.io config, you can define :bulk
and :trusted_domains
bulk: %{email: %{trusted: 100, untrusted: 3}},
trusted_domains: MapSet.new(["paraxial.io", "blackcatprojects.xyz"])
In your application code,
Paraxial.bulk_allowed?(user.email, :email, length(list_of_emails))
will return true or false, depending on the value of the third argument (an integer), and if the email matching a trusted domain.