Skip to content

Commit

Permalink
Adds docs for Teams shared secrets (#2317)
Browse files Browse the repository at this point in the history
* Adds docs for Teams shared secrets

* Mentions a shared secret can be added from a notebook

* Reorder groups in docs sidebar
  • Loading branch information
hugobarauna authored Nov 1, 2023
1 parent 6ec335f commit ec90333
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 1 deletion.
Binary file added docs/images/add_shared_secret.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/add_shared_secret_from_notebook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 29 additions & 0 deletions docs/teams/shared_secrets.md
Original file line number Diff line number Diff line change
@@ -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.

![](assets/add_shared_secret.png)

You can also create such secrets directly from a notebook.

![](assets/add_shared_secret_from_notebook.png)

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 changes: 4 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -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/*")
]
]
Expand All @@ -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

0 comments on commit ec90333

Please sign in to comment.