defmodule LivebookWeb.SettingsLive do use LivebookWeb, :live_view alias LivebookWeb.LayoutComponents on_mount LivebookWeb.SidebarHook @impl true def mount(_params, _session, socket) do if connected?(socket) do Livebook.Settings.subscribe() end {:ok, assign(socket, env_vars: Livebook.Settings.fetch_env_vars() |> Enum.sort(), env_var: nil, autosave_path_state: %{ file: autosave_dir(), dialog_opened?: false }, update_check_enabled: Livebook.UpdateCheck.enabled?(), page_title: "Settings - Livebook" )} end @impl true def render(assigns) do ~H"""

Here you can change global Livebook configuration. Keep in mind that this configuration gets persisted and will be restored on application launch.

About

<.labeled_text :if={app_name = Livebook.Config.app_service_name()} label="Application"> <%= if app_url = Livebook.Config.app_service_url() do %> <%= app_name %> <% else %> <%= app_name %> <% end %> <.labeled_text label="Livebook"> v<%= Livebook.Config.app_version() %> <.labeled_text label="Elixir"> v<%= System.version() %>
<.button navigate={~p"/dashboard"} color="gray" outlined> <.remix_icon icon="dashboard-2-line" /> Open dashboard

Updates

<.switch_field name="update_check_enabled" label="Show banner when a new Livebook version is available" value={@update_check_enabled} />

Autosave

The directory to keep unsaved notebooks.

<.autosave_path_select state={@autosave_path_state} />

Environment variables

Environment variables store global values, specific to this Livebook instance, which are available inside your notebooks. You can also configure the PATH environment to make system dependencies available to notebooks.

<.live_component module={LivebookWeb.SettingsLive.EnvVarsComponent} id="env-vars" env_vars={@env_vars} return_to={~p"/settings"} />
<.button patch={~p"/settings/env-var/new"} id="add-env-var"> Add environment variable

The configuration in this section changes only your Livebook experience and is saved in your browser.

Code editor

<.switch_field name="editor_auto_completion" label="Show completion list while typing" value={false} /> <.switch_field name="editor_auto_signature" label="Show function signature while typing" value={false} /> <.switch_field name="editor_font_size" label="Increase font size" value={false} /> <.switch_field name="editor_ligatures" label="Render ligatures" value={false} /> <.switch_field name="editor_light_theme" label="Use light theme" value={false} /> <.switch_field name="editor_markdown_word_wrap" label="Wrap words in Markdown" value={false} />
Key bindings <.select_field name="editor_mode" value={false} class="pt-1 pb-1" options={[ {"Default", "default"}, {"Emacs", "emacs"}, {"Vim", "vim"} ]} />
<.modal :if={@live_action in [:add_env_var, :edit_env_var]} id="env-var-modal" show width={:medium} patch={~p"/settings"} > <.live_component module={LivebookWeb.SettingsLive.EnvVarComponent} id="env-var" env_var={@env_var} headline="Configure your application global environment variables." return_to={~p"/settings"} /> """ end defp autosave_path_select(%{state: %{file: nil}} = assigns) do ~H"""
<.button color="gray" id="enable-autosave" phx-click="open_autosave_path_select"> Enable
""" end defp autosave_path_select(%{state: %{dialog_opened?: true}} = assigns) do ~H"""
<.live_component module={LivebookWeb.FileSelectComponent} id="autosave-path-component" file={@state.file} extnames={[]} running_files={[]} on_submit={JS.push("set_autosave_path")} file_system_select_disabled={true} target={self()} > <.button id="cancel-autosave" color="gray" phx-click="cancel_autosave_path" tabindex="-1"> Cancel <.button id="reset-autosave" color="gray" phx-click="reset_autosave_path" tabindex="-1"> Reset <.button id="save-autosave" phx-click="set_autosave_path" disabled={not Livebook.FileSystem.File.dir?(@state.file)} tabindex="-1" > Save
""" end defp autosave_path_select(assigns) do ~H"""
<.text_field name={nil} readonly value={@state.file.path} />
<.button color="gray" id="change-autosave" phx-click="open_autosave_path_select"> Change
""" end @impl true def handle_params(%{"env_var_id" => key}, _url, socket) do env_var = Livebook.Settings.fetch_env_var!(key) {:noreply, assign(socket, env_var: env_var)} end def handle_params(_params, _url, socket), do: {:noreply, assign(socket, env_var: nil)} @impl true def handle_event("cancel_autosave_path", %{}, socket) do {:noreply, update( socket, :autosave_path_state, &%{&1 | dialog_opened?: false, file: autosave_dir()} )} end def handle_event("set_autosave_path", %{}, socket) do path = socket.assigns.autosave_path_state.file.path Livebook.Settings.set_autosave_path(path) {:noreply, update( socket, :autosave_path_state, &%{&1 | dialog_opened?: false, file: autosave_dir()} )} end @impl true def handle_event("reset_autosave_path", %{}, socket) do {:noreply, update( socket, :autosave_path_state, &%{&1 | file: default_autosave_dir()} )} end def handle_event("open_autosave_path_select", %{}, socket) do {:noreply, update( socket, :autosave_path_state, &%{&1 | dialog_opened?: true, file: &1.file || default_autosave_dir()} )} end def handle_event("save", %{"update_check_enabled" => enabled}, socket) do enabled = enabled == "true" Livebook.UpdateCheck.set_enabled(enabled) {:noreply, assign(socket, :update_check_enabled, enabled)} end def handle_event("save", %{"env_var" => attrs}, socket) do env_var = socket.assigns.env_var || %Livebook.Settings.EnvVar{} case Livebook.Settings.set_env_var(env_var, attrs) do {:ok, _} -> {:noreply, push_patch(socket, to: ~p"/settings")} {:error, _changeset} -> {:noreply, socket} end end def handle_event("edit_env_var", %{"env_var" => key}, socket) do {:noreply, push_patch(socket, to: "/settings/env-var/edit/#{key}")} end def handle_event("delete_env_var", %{"env_var" => key}, socket) do on_confirm = fn socket -> Livebook.Settings.unset_env_var(key) socket end {:noreply, confirm(socket, on_confirm, title: "Delete #{key}", description: "Are you sure you want to delete environment variable?", confirm_text: "Delete", confirm_icon: "delete-bin-6-line" )} end @impl true def handle_info({:set_file, file, _info}, socket) do {:noreply, update(socket, :autosave_path_state, &%{&1 | file: file})} end def handle_info({:env_var_set, env_var}, socket) do idx = Enum.find_index(socket.assigns.env_vars, &(&1.name == env_var.name)) env_vars = if idx, do: List.replace_at(socket.assigns.env_vars, idx, env_var), else: [env_var | socket.assigns.env_vars] {:noreply, assign(socket, env_vars: Enum.sort(env_vars), env_var: nil)} end def handle_info({:env_var_unset, env_var}, socket) do env_vars = Enum.reject(socket.assigns.env_vars, &(&1.name == env_var.name)) {:noreply, assign(socket, env_vars: env_vars, env_var: nil)} end def handle_info(_message, socket), do: {:noreply, socket} defp autosave_dir() do if path = Livebook.Settings.autosave_path() do path |> Livebook.FileSystem.Utils.ensure_dir_path() |> Livebook.FileSystem.File.local() end end defp default_autosave_dir() do Livebook.Settings.default_autosave_path() |> Livebook.FileSystem.Utils.ensure_dir_path() |> Livebook.FileSystem.File.local() end end