Plug v1.6.0 Plug.Session View Source

A plug to handle session cookies and session stores.

The session is accessed via functions on Plug.Conn. Cookies and session have to be fetched with Plug.Conn.fetch_session/1 before the session can be accessed.

Consider using Plug.CSRFProtection when using Plug.Session.

Session stores

See Plug.Session.Store for the specification session stores are required to implement.

Plug ships with the following session stores:

Options

:store - session store module (required);
:key - session cookie key (required);
:domain - see Plug.Conn.put_resp_cookie/4;
:max_age - see Plug.Conn.put_resp_cookie/4;
:path - see Plug.Conn.put_resp_cookie/4;
:secure - see Plug.Conn.put_resp_cookie/4;
:http_only - see Plug.Conn.put_resp_cookie/4;
:extra - see Plug.Conn.put_resp_cookie/4;

Additional options can be given to the session store, see the store’s documentation for the options it accepts.

Examples

plug Plug.Session, store: :ets, key: "_my_app_session", table: :session

Link to this section Summary

Functions

call(conn, config)

Callback implementation for Plug.call/2

init(opts)

Callback implementation for Plug.init/1

Link to this section Functions

call(conn, config)

Callback implementation for Plug.call/2.

init(opts)

Callback implementation for Plug.init/1.