mirror of
https://github.com/livebook-dev/livebook.git
synced 2026-01-06 15:44:54 +08:00
Adds docs for Teams shared secrets (#2317)
* Adds docs for Teams shared secrets * Mentions a shared secret can be added from a notebook * Reorder groups in docs sidebar
This commit is contained in:
parent
6ec335fce5
commit
ec90333a00
4 changed files with 33 additions and 1 deletions
BIN
docs/images/add_shared_secret.png
Normal file
BIN
docs/images/add_shared_secret.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
BIN
docs/images/add_shared_secret_from_notebook.png
Normal file
BIN
docs/images/add_shared_secret_from_notebook.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
29
docs/teams/shared_secrets.md
Normal file
29
docs/teams/shared_secrets.md
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# Shared secrets management
|
||||
|
||||
## Overview
|
||||
|
||||
This feature allows your team to share Livebook secrets among team members in an easy way.
|
||||
|
||||
Just add a secret to your organization hub, and Livebook Teams will synchronize it with the Livebook of every member of your organization.
|
||||
|
||||

|
||||
|
||||
You can also create such secrets directly from a notebook.
|
||||
|
||||

|
||||
|
||||
Shared secrets updates and deletions will also be synchronized.
|
||||
|
||||
## How it works
|
||||
|
||||
Here's a video showing how that feature works.
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/GENSmArO1AI?si=pvMJt1Ihr5UBCkPP" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
## Security strengths
|
||||
|
||||
Livebook Teams cannot access the plain text version of your organization's secrets.
|
||||
|
||||
Livebook encrypts your secrets locally in your machine using your Teams key. Then, the secret is sent encrypted to Livebook Teams servers.
|
||||
|
||||
When a new synchronization is needed, Livebook Teams sends the encrypted secret to the Livebook of team members, and their Livebook decrypts the secret in their local machines using the same Teams key.
|
||||
5
mix.exs
5
mix.exs
|
|
@ -194,7 +194,9 @@ defmodule Livebook.MixProject do
|
|||
extra_section: "Guides",
|
||||
extras: extras(),
|
||||
filter_modules: fn mod, _ -> mod in [Livebook] end,
|
||||
assets: Path.expand("./docs/images"),
|
||||
groups_for_extras: [
|
||||
"Livebook Teams": Path.wildcard("docs/teams/*"),
|
||||
Deployment: Path.wildcard("docs/deployment/*")
|
||||
]
|
||||
]
|
||||
|
|
@ -207,7 +209,8 @@ defmodule Livebook.MixProject do
|
|||
"docs/deployment/docker.md",
|
||||
"docs/deployment/cloudflare.md",
|
||||
"docs/deployment/google_iap.md",
|
||||
"docs/deployment/tailscale.md"
|
||||
"docs/deployment/tailscale.md",
|
||||
"docs/teams/shared_secrets.md"
|
||||
]
|
||||
end
|
||||
end
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue