plausible/analytics
1
1
Fork 0
mirror of https://github.com/plausible/analytics.git synced 2024-11-30 11:13:22 +03:00
Code Issues Packages Projects Releases Wiki Activity
e142fcbbe1
analytics/PlausibleWeb.Endpoint.html
macobo 390b3c30ae deploy: 9c71161eab
2024-08-26 11:02:11 +00:00

1111 lines
37 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="ExDoc v0.31.1">
<meta name="project" content="Plausible v0.0.1">
<title>PlausibleWeb.Endpoint — Plausible v0.0.1</title>
<link rel="stylesheet" href="dist/html-elixir-FM2CSD74.css" />
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
<script src="dist/handlebars.templates-43PMFBC7.js"></script>
<script src="dist/sidebar_items-9CE21158.js"></script>
<script src="docs_config.js"></script>
<script async src="dist/html-L4O5OK2K.js"></script>
</head>
<body data-type="modules" class="page-module">
<script>
try {
var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}');
if (settings.theme === 'dark' ||
((settings.theme === 'system' || settings.theme == null) &&
window.matchMedia('(prefers-color-scheme: dark)').matches)
) {
document.body.classList.add('dark')
}
} catch (error) { }
</script>
<div class="main">
<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
<i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>
<div class="background-layer"></div>
<nav id="sidebar" class="sidebar">
<div class="sidebar-header">
<div class="sidebar-projectInfo">
<a href="readme.html" class="sidebar-projectImage">
<img src="assets/logo.png" alt="Plausible" />
</a>
<div>
<a href="readme.html" class="sidebar-projectName" translate="no">
Plausible
</a>
<div class="sidebar-projectVersion" translate="no">
v0.0.1
</div>
</div>
</div>
<ul id="sidebar-listNav" class="sidebar-listNav" role="tablist">
<li>
<button id="extras-list-tab-button" role="tab" data-type="extras" aria-controls="extras-tab-panel" aria-selected="true" tabindex="0">
Pages
</button>
</li>
<li>
<button id="modules-list-tab-button" role="tab" data-type="modules" aria-controls="modules-tab-panel" aria-selected="false" tabindex="-1">
Modules
</button>
</li>
<li>
<button id="tasks-list-tab-button" role="tab" data-type="tasks" aria-controls="tasks-tab-panel" aria-selected="false" tabindex="-1">
<span translate="no">Mix</span> Tasks
</button>
</li>
</ul>
</div>
<div id="extras-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="extras-list-tab-button">
<ul id="extras-full-list" class="full-list"></ul>
</div>
<div id="modules-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="modules-list-tab-button" hidden>
<ul id="modules-full-list" class="full-list"></ul>
</div>
<div id="tasks-tab-panel" class="sidebar-tabpanel" role="tabpanel" aria-labelledby="tasks-list-tab-button" hidden>
<ul id="tasks-full-list" class="full-list"></ul>
</div>
</nav>
<main class="content">
<output role="status" id="toast"></output>
<div class="content-outer">
<div id="content" class="content-inner">
<div class="top-search">
<div class="search-settings">
<form class="search-bar" action="search.html">
<label class="search-label">
<span class="sr-only">Search documentation of Plausible</span>
<input name="q" type="text" class="search-input" placeholder="Search Documentation (press /)" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
</label>
<button type="submit" class="search-button" aria-label="Submit Search">
<i class="ri-search-2-line ri-lg" aria-hidden="true" title="Submit search"></i>
</button>
<button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
<i class="ri-close-line ri-lg" title="Cancel search"></i>
</button>
</form>
<div class="autocomplete">
</div>
<button class="icon-settings display-settings">
<i class="ri-settings-3-line"></i>
<span class="sr-only">Settings</span>
</button>
</div>
</div>
<h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L1" title="View Source" class="icon-action" rel="help">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
<span translate="no">PlausibleWeb.Endpoint</span>
<small class="app-vsn" translate="no">(Plausible v0.0.1)</small>
</h1>
<section id="summary" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#summary">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Summary</span>
</h1>
<div class="summary-functions summary">
<h2>
<a href="#functions">Functions</a>
</h2>
<div class="summary-row">
<div class="summary-signature">
<a href="#broadcast/3" translate="no">broadcast(topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast/3"><code class="inline">Phoenix.Endpoint.broadcast/3</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#broadcast!/3" translate="no">broadcast!(topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast!/3"><code class="inline">Phoenix.Endpoint.broadcast!/3</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#broadcast_from/4" translate="no">broadcast_from(from, topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast_from/4"><code class="inline">Phoenix.Endpoint.broadcast_from/4</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#broadcast_from!/4" translate="no">broadcast_from!(from, topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast_from!/4"><code class="inline">Phoenix.Endpoint.broadcast_from!/4</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#call/2" translate="no">call(conn, opts)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/plug/1.16.1/Plug.html#c:call/2"><code class="inline">Plug.call/2</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#child_spec/1" translate="no">child_spec(opts)</a>
</div>
<div class="summary-synopsis"><p>Returns the child specification to start the endpoint
under a supervision tree.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#config/2" translate="no">config(key, default \\ nil)</a>
</div>
<div class="summary-synopsis"><p>Returns the endpoint configuration for <code class="inline">key</code></p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#config_change/2" translate="no">config_change(changed, removed)</a>
</div>
<div class="summary-synopsis"><p>Reloads the configuration given the application environment changes.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#host/0" translate="no">host()</a>
</div>
<div class="summary-synopsis"><p>Returns the host for the given endpoint.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#init/1" translate="no">init(opts)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/plug/1.16.1/Plug.html#c:init/1"><code class="inline">Plug.init/1</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#local_broadcast/3" translate="no">local_broadcast(topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:local_broadcast/3"><code class="inline">Phoenix.Endpoint.local_broadcast/3</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#local_broadcast_from/4" translate="no">local_broadcast_from(from, topic, event, msg)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:local_broadcast_from/4"><code class="inline">Phoenix.Endpoint.local_broadcast_from/4</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#path/1" translate="no">path(path)</a>
</div>
<div class="summary-synopsis"><p>Generates the path information when routing to this endpoint.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#runtime_session/2" translate="no">runtime_session(conn, opts)</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#runtime_session_opts/0" translate="no">runtime_session_opts()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#script_name/0" translate="no">script_name()</a>
</div>
<div class="summary-synopsis"><p>Generates the script name.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#secure_cookie?/0" translate="no">secure_cookie?()</a>
</div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#server_info/1" translate="no">server_info(scheme)</a>
</div>
<div class="summary-synopsis"><p>Returns the address and port that the server is running on</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#start_link/1" translate="no">start_link(opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>Starts the endpoint supervision tree.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#static_integrity/1" translate="no">static_integrity(path)</a>
</div>
<div class="summary-synopsis"><p>Generates a base64-encoded cryptographic hash (sha512) to a static file
in <code class="inline">priv/static</code>. Meant to be used for Subresource Integrity with CDNs.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#static_lookup/1" translate="no">static_lookup(path)</a>
</div>
<div class="summary-synopsis"><p>Returns a two item tuple with the first item being the <code class="inline">static_path</code>
and the second item being the <code class="inline">static_integrity</code>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#static_path/1" translate="no">static_path(path)</a>
</div>
<div class="summary-synopsis"><p>Generates a route to a static file in <code class="inline">priv/static</code>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#static_url/0" translate="no">static_url()</a>
</div>
<div class="summary-synopsis"><p>Generates the static URL without any path information.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#struct_url/0" translate="no">struct_url()</a>
</div>
<div class="summary-synopsis"><p>Generates the endpoint base URL but as a <a href="https://hexdocs.pm/elixir/URI.html"><code class="inline">URI</code></a> struct.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#subscribe/2" translate="no">subscribe(topic, opts \\ [])</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:subscribe/2"><code class="inline">Phoenix.Endpoint.subscribe/2</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#unsubscribe/1" translate="no">unsubscribe(topic)</a>
</div>
<div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:unsubscribe/1"><code class="inline">Phoenix.Endpoint.unsubscribe/1</code></a>.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#url/0" translate="no">url()</a>
</div>
<div class="summary-synopsis"><p>Generates the endpoint base URL without any path information.</p></div>
</div>
<div class="summary-row">
<div class="summary-signature">
<a href="#websocket_url/0" translate="no">websocket_url()</a>
</div>
</div>
</div>
</section>
<section id="functions" class="details-list">
<h1 class="section-heading">
<a class="hover-link" href="#functions">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
<span class="text">Functions</span>
</h1>
<div class="functions-list">
<section class="detail" id="broadcast/3">
<div class="detail-header">
<a href="#broadcast/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">broadcast(topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast/3"><code class="inline">Phoenix.Endpoint.broadcast/3</code></a>.</p>
</section>
</section>
<section class="detail" id="broadcast!/3">
<div class="detail-header">
<a href="#broadcast!/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">broadcast!(topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast!/3"><code class="inline">Phoenix.Endpoint.broadcast!/3</code></a>.</p>
</section>
</section>
<section class="detail" id="broadcast_from/4">
<div class="detail-header">
<a href="#broadcast_from/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">broadcast_from(from, topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast_from/4"><code class="inline">Phoenix.Endpoint.broadcast_from/4</code></a>.</p>
</section>
</section>
<section class="detail" id="broadcast_from!/4">
<div class="detail-header">
<a href="#broadcast_from!/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">broadcast_from!(from, topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:broadcast_from!/4"><code class="inline">Phoenix.Endpoint.broadcast_from!/4</code></a>.</p>
</section>
</section>
<section class="detail" id="call/2">
<div class="detail-header">
<a href="#call/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">call(conn, opts)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L1" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/plug/1.16.1/Plug.html#c:call/2"><code class="inline">Plug.call/2</code></a>.</p>
</section>
</section>
<section class="detail" id="child_spec/1">
<div class="detail-header">
<a href="#child_spec/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">child_spec(opts)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns the child specification to start the endpoint
under a supervision tree.</p>
</section>
</section>
<section class="detail" id="config/2">
<span id="config/1"></span>
<div class="detail-header">
<a href="#config/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">config(key, default \\ nil)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns the endpoint configuration for <code class="inline">key</code></p><p>Returns <code class="inline">default</code> if the key does not exist.</p>
</section>
</section>
<section class="detail" id="config_change/2">
<div class="detail-header">
<a href="#config_change/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">config_change(changed, removed)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Reloads the configuration given the application environment changes.</p>
</section>
</section>
<section class="detail" id="host/0">
<div class="detail-header">
<a href="#host/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">host()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns the host for the given endpoint.</p>
</section>
</section>
<section class="detail" id="init/1">
<div class="detail-header">
<a href="#init/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">init(opts)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/plug/1.16.1/Plug.html#c:init/1"><code class="inline">Plug.init/1</code></a>.</p>
</section>
</section>
<section class="detail" id="local_broadcast/3">
<div class="detail-header">
<a href="#local_broadcast/3" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">local_broadcast(topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:local_broadcast/3"><code class="inline">Phoenix.Endpoint.local_broadcast/3</code></a>.</p>
</section>
</section>
<section class="detail" id="local_broadcast_from/4">
<div class="detail-header">
<a href="#local_broadcast_from/4" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">local_broadcast_from(from, topic, event, msg)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:local_broadcast_from/4"><code class="inline">Phoenix.Endpoint.local_broadcast_from/4</code></a>.</p>
</section>
</section>
<section class="detail" id="path/1">
<div class="detail-header">
<a href="#path/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">path(path)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates the path information when routing to this endpoint.</p>
</section>
</section>
<section class="detail" id="runtime_session/2">
<div class="detail-header">
<a href="#runtime_session/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">runtime_session(conn, opts)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L96" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="runtime_session_opts/0">
<div class="detail-header">
<a href="#runtime_session_opts/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">runtime_session_opts()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L100" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="script_name/0">
<div class="detail-header">
<a href="#script_name/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">script_name()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates the script name.</p>
</section>
</section>
<section class="detail" id="secure_cookie?/0">
<div class="detail-header">
<a href="#secure_cookie?/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">secure_cookie?()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L90" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
<section class="detail" id="server_info/1">
<div class="detail-header">
<a href="#server_info/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">server_info(scheme)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns the address and port that the server is running on</p>
</section>
</section>
<section class="detail" id="start_link/1">
<span id="start_link/0"></span>
<div class="detail-header">
<a href="#start_link/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">start_link(opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Starts the endpoint supervision tree.</p><p>All other options are merged into the endpoint configuration.</p>
</section>
</section>
<section class="detail" id="static_integrity/1">
<div class="detail-header">
<a href="#static_integrity/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">static_integrity(path)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates a base64-encoded cryptographic hash (sha512) to a static file
in <code class="inline">priv/static</code>. Meant to be used for Subresource Integrity with CDNs.</p>
</section>
</section>
<section class="detail" id="static_lookup/1">
<div class="detail-header">
<a href="#static_lookup/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">static_lookup(path)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Returns a two item tuple with the first item being the <code class="inline">static_path</code>
and the second item being the <code class="inline">static_integrity</code>.</p>
</section>
</section>
<section class="detail" id="static_path/1">
<div class="detail-header">
<a href="#static_path/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">static_path(path)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates a route to a static file in <code class="inline">priv/static</code>.</p>
</section>
</section>
<section class="detail" id="static_url/0">
<div class="detail-header">
<a href="#static_url/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">static_url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates the static URL without any path information.</p><p>It uses the configuration under <code class="inline">:static_url</code> to generate
such. It falls back to <code class="inline">:url</code> if <code class="inline">:static_url</code> is not set.</p>
</section>
</section>
<section class="detail" id="struct_url/0">
<div class="detail-header">
<a href="#struct_url/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">struct_url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates the endpoint base URL but as a <a href="https://hexdocs.pm/elixir/URI.html"><code class="inline">URI</code></a> struct.</p><p>It uses the configuration under <code class="inline">:url</code> to generate such.
Useful for manipulating the URL data and passing it to
URL helpers.</p>
</section>
</section>
<section class="detail" id="subscribe/2">
<span id="subscribe/1"></span>
<div class="detail-header">
<a href="#subscribe/2" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">subscribe(topic, opts \\ [])</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:subscribe/2"><code class="inline">Phoenix.Endpoint.subscribe/2</code></a>.</p>
</section>
</section>
<section class="detail" id="unsubscribe/1">
<div class="detail-header">
<a href="#unsubscribe/1" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">unsubscribe(topic)</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Callback implementation for <a href="https://hexdocs.pm/phoenix/1.7.10/Phoenix.Endpoint.html#c:unsubscribe/1"><code class="inline">Phoenix.Endpoint.unsubscribe/1</code></a>.</p>
</section>
</section>
<section class="detail" id="url/0">
<div class="detail-header">
<a href="#url/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L4" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
<p>Generates the endpoint base URL without any path information.</p><p>It uses the configuration under <code class="inline">:url</code> to generate such.</p>
</section>
</section>
<section class="detail" id="websocket_url/0">
<div class="detail-header">
<a href="#websocket_url/0" class="detail-link" title="Link to this function">
<i class="ri-link-m" aria-hidden="true"></i>
<span class="sr-only">Link to this function</span>
</a>
<h1 class="signature" translate="no">websocket_url()</h1>
<a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/endpoint.ex#L92" class="icon-action" rel="help" title="View Source">
<i class="ri-code-s-slash-line" aria-hidden="true"></i>
<span class="sr-only">View Source</span>
</a>
</div>
<section class="docstring">
</section>
</section>
</div>
</section>
<footer class="footer">
<p>
<span class="line">
<button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
Search HexDocs
</button>
<a href="Plausible.epub" title="ePub version">
Download ePub version
</a>
</span>
</p>
<p class="built-using">
Built using
<a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.31.1) for the
<a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>
</p>
</footer>
</div>
</div>
</main>
</div>
<script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad: true})</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink