livebook-dev/livebook
1
1
Fork 0
mirror of https://github.com/livebook-dev/livebook.git synced 2025-02-23 14:27:15 +08:00
Code Issues Projects Releases Packages Wiki Activity

Improve docs for runtimes (#1630)

Browse source
This commit is contained in:
José Valim 2023-01-08 12:47:43 +01:00 committed by GitHub
parent d6f758661b
commit ee1fea2993
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

46
lib/livebook/notebook/learn/elixir_and_livebook.livemd
View file

@ -51,21 +51,6 @@ IO.puts(__ENV__.file)
IO.puts(__DIR__) IO.puts(__DIR__)
``` ```
## Runtimes
Livebook has a concept of **runtime**, which in practice is an Elixir node responsible
for evaluating your code. You can choose the runtime by clicking the "Runtime" icon
(<i class="ri-livebook-runtime"></i>) on the sidebar (or by using the <kbd>s</kbd> <kbd>r</kbd>
keyboard shortcut).
By default, a new Elixir node is started (similarly to starting `iex`). You
can click reconnect whenever you want to discard the current node and start
a new one.
You can also manually *attach* to an existing distributed node by picking the
"Attached Node" runtime. To do so, you will need the Erlang Name of the external
node and its Erlang Cookie.
## Mix projects ## Mix projects
Sometimes you may want to run a notebook within the context of an existing Sometimes you may want to run a notebook within the context of an existing
@ -90,6 +75,37 @@ Mix.install(
) )
``` ```
## Runtimes
Livebook has a concept of **runtime**, which in practice is an Elixir node responsible
for evaluating your code. You can choose the runtime by clicking the "Runtime" icon
(<i class="ri-livebook-runtime"></i>) on the sidebar (or by using the <kbd>s</kbd> <kbd>r</kbd>
keyboard shortcut).
By default, a new Elixir node is started (similarly to starting `iex`). You can click
reconnect whenever you want to discard the current node and start a new one.
You can also manually *attach* to an existing distributed node by picking the
"Attached Node" runtime. To do so, you will need the Erlang Name of the external node
and its Erlang Cookie. For example, you can start a Phoenix application as follows:
```shell
$ iex --sname phoenix-app --cookie secret -S mix phx.server
```
Now open up a new notebook and click the "Runtime" icon on the sidebar.
Click to "Configure" the runtime and choose "Attached node". Input the
name and cookie as above and you should be ready to connect to it.
Note, however, that you can't install new dependencies on a connected runtime.
If you want to install dependencies, you have two options:
1. Use the Mix project approach outlined in the previous section;
2. Use a regular notebook and use `Node.connect/1`](https://hexdocs.pm/elixir/Node.html#connect/1)
to connect to your application. Use [the `:erpc` module](https://www.erlang.org/doc/man/erpc.html)
to fetch data from the remote node and execute code.
## More on branches #1 ## More on branches #1
We already mentioned branching sections in We already mentioned branching sections in