PhoenixKit.WebsiteAccess.Environment (phoenix_kit v2.26.0)

Copy Markdown View Source

How this install is running. looks_like_dev? drives the automatic "[dev]" tag next to the project title in the admin header (LayoutWrapper), so a dev or staging box tells itself apart without an admin having to switch anything on. It never switches anything on by itself.

Summary

Types

t()

Functions

read()

Types

t()

@type t() :: %{
  runtime: :release | :mix,
  mix_env: String.t() | nil,
  hostname: String.t(),
  site_url: String.t() | nil,
  looks_like_dev?: boolean(),
  reasons: [{:mix_env | :hostname | :site_url, String.t()}]
}

Functions

read()

@spec read() :: t()