site_encrypt v0.5.0

View Source SiteEncrypt.Phoenix (site_encrypt v0.5.0)

SiteEncrypt adapter for Phoenix endpoints.

usage

 Usage

  1. Add use SiteEncrypt.Phoenix to your endpoint immediately after use Phoenix.Endpoint
  2. Configure https via configure_https/2.
  3. Add the implementation of SiteEncrypt.certification/0 to the endpoint (the @behaviour SiteEncrypt is injected when this module is used).
  4. Start the endpoint by providing {SiteEncrypt.Phoenix, PhoenixDemo.Endpoint} as a supervisor child.

Link to this section Summary

Functions

child_spec(start_opts)

Returns a specification to start this module under a supervisor.

configure_https(config, https_opts \\ [])

Merges paths to key and certificates to the :https configuration of the endpoint config for Cowboy.

start_link(endpoint)

Starts the endpoint managed by SiteEncrypt.

Link to this section Functions

Link to this function

child_spec(start_opts)

View Source 
@spec child_spec(endpoint :: module()) :: Supervisor.child_spec()

Returns a specification to start this module under a supervisor.

See Supervisor.

Link to this macro

configure_https(config, https_opts \\ [])

View Source (macro)

Merges paths to key and certificates to the :https configuration of the endpoint config for Cowboy.

Invoke this macro from Phoenix.Endpoint.init/2 to complete the https configuration:

defmodule MyEndpoint do
  # ...

  @impl Phoenix.Endpoint
  def init(_key, config) do
    # this will merge key, cert, and chain into `:https` configuration from config.exs
    {:ok, SiteEncrypt.Phoenix.configure_https(config)}

    # to completely configure https from `init/2`, invoke:
    #   SiteEncrypt.Phoenix.configure_https(config, port: 4001, ...)
  end

  # ...
end

The options are any valid adapter HTTPS options. For many great tips on configuring HTTPS for production refer to the Plug HTTPS guide.

Link to this function

start_link(endpoint)

View Source 
@spec start_link(endpoint :: module()) :: Supervisor.on_start()

Starts the endpoint managed by SiteEncrypt.