Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add LIVEBOOK_FORCE_SSL env #1064

Merged
merged 8 commits into from
Mar 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,9 @@ The following environment variables configure Livebook:
Enabled by default unless `LIVEBOOK_PASSWORD` is set. Set it to "false" to
disable it.

* LIVEBOOK_FORCE_SSL_HOST - set a host to redirect to if the request is not over HTTP.
Note it does not apply when accessing Livebook via localhost. Defaults to nil.

<!-- Environment variables -->

If running Livebook as a Docker image or an Elixir release, [the environment
Expand Down
4 changes: 4 additions & 0 deletions lib/livebook.ex
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,10 @@ defmodule Livebook do
config :livebook, :data_path, data_path
end

if force_ssl_host = Livebook.Config.force_ssl_host!("LIVEBOOK_FORCE_SSL_HOST") do
config :livebook, :force_ssl_host, force_ssl_host
end

config :livebook,
:cookie,
Livebook.Config.cookie!("LIVEBOOK_COOKIE") ||
Expand Down
7 changes: 7 additions & 0 deletions lib/livebook/config.ex
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,13 @@ defmodule Livebook.Config do
System.get_env(env, "1") in ~w(true 1)
end

@doc """
Parses force ssl host setting from env.
"""
def force_ssl_host!(env) do
System.get_env(env)
end

@doc """
Parses and validates default runtime from env.
"""
Expand Down
13 changes: 13 additions & 0 deletions lib/livebook_web/endpoint.ex
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@ defmodule LivebookWeb.Endpoint do
file_provider: AssetsMemoryProvider,
gzip: true

plug :force_ssl

# Code reloading can be explicitly enabled under the
# :code_reloader configuration of your endpoint.
if code_reloading? do
Expand Down Expand Up @@ -83,6 +85,17 @@ defmodule LivebookWeb.Endpoint do

plug LivebookWeb.Router

@plug_ssl Plug.SSL.init(host: {Application, :get_env, [:livebook, :force_ssl_host, nil]})
def force_ssl(conn, _opts) do
force_ssl_host = Application.get_env(:livebook, :force_ssl_host, nil)

if force_ssl_host do
Plug.SSL.call(conn, @plug_ssl)
else
conn
end
end

def access_struct_url() do
base =
case struct_url() do
Expand Down