diff --git a/docs/config.md b/docs/config.md index 2429c84..dcb47c2 100644 --- a/docs/config.md +++ b/docs/config.md @@ -54,8 +54,8 @@ sharing: # sharing env files as encrypted links ``` More, each on its own page: [repos](repos.md) (`providers.repos`), -[sharing env files](links.md#sharing-env-files) (`sharing`), the -[link handler](links.md#from-the-browser-and-chat) (`linkHandler`), +[sharing env files](sharing.md#sharing-env-files) (`sharing`), the +[link handler](sharing.md#from-the-browser-and-chat) (`linkHandler`), [keybindings](keys.md#rebinding-keys) (`keybinding`) and [custom commands](custom-commands.md) (`customCommands`). diff --git a/docs/keys.md b/docs/keys.md index 3bc1536..90e862c 100644 --- a/docs/keys.md +++ b/docs/keys.md @@ -54,7 +54,7 @@ match case exactly. | `v` | versions of the selected item (Azure); `space`/`y`/`Y` then act on that version; `esc`, `⌫` or `v` to go back | | `o` | open the selected item in the browser (over SSH: copy the link) | | `e` | open the selected SOPS or `.env` file, or a secret's file at its line ([how](repos.md#opening-files)) | -| `s` / `S` | copy a [link](links.md) to the selected item / share menu (also env files, [encrypted](links.md#sharing-env-files)) | +| `s` / `S` | copy a [link](sharing.md) to the selected item / share menu (also env files, [encrypted](sharing.md#sharing-env-files)) | | `ctrl+o` | open a link or reference (or just paste one) | | `x` | [custom commands](custom-commands.md) | | `L` | sign in again (shown when a login has expired) | diff --git a/docs/repos.md b/docs/repos.md index 47da3a9..3a994a7 100644 --- a/docs/repos.md +++ b/docs/repos.md @@ -58,7 +58,7 @@ providers: ``` A repo's `.lazysecrets.yaml` can also name the secret its env files are -[shared](links.md#sharing-env-files) with: +[shared](sharing.md#sharing-env-files) with: ```yaml sharing: @@ -100,7 +100,7 @@ sops 3.8 or later. ## Links -`S` → `f` shares env files as an [encrypted link](links.md#sharing-env-files). +`S` → `f` shares env files as an [encrypted link](sharing.md#sharing-env-files). Links name the repo by its git remote, so they open in a colleague's clone wherever it is: @@ -109,4 +109,4 @@ wherever it is: lazysecrets://repo/git.example.com%2Fteam%2Finfra/secrets%2Fapp.yaml/db.password ``` -See [links](links.md). +See [sharing](sharing.md). diff --git a/docs/links.md b/docs/sharing.md similarity index 98% rename from docs/links.md rename to docs/sharing.md index 53139f5..5145e84 100644 --- a/docs/links.md +++ b/docs/sharing.md @@ -1,7 +1,7 @@ -# Links +# Sharing -Subscriptions, workspaces, vaults, scopes, repos, files and secrets can -be shared as a `lazysecrets://` link, in chat or a ticket. Whoever opens +Subscriptions, workspaces, vaults, scopes, repos, files and secrets are +shared as a `lazysecrets://` link, in chat or a ticket. Whoever opens it lands on that item, reading it with their own account and permissions: the link names the item, never its value. Env files can also be [shared encrypted](#sharing-env-files), in the link itself. @@ -15,7 +15,7 @@ lazysecrets://databricks/adb-1111111111111111.11.azuredatabricks.net/app/storage lazysecrets://repo/git.example.com%2Fteam%2Finfra/secrets%2Fapp.yaml/db.password ``` -## Sharing +## Sharing a link `s` copies a link to the selected item (from the versions view, pinned to that version). `S` opens the share menu: @@ -99,7 +99,7 @@ the value breaks every old link. Whoever has read the secret's value before can decrypt links made with it without asking the vault, so rotate it now and then: new links use the newest version. -## Opening +## Opening a link - Paste it into lazysecrets, or press `ctrl+o`, which reads the clipboard and fills in any reference it finds there. Key Vault URLs,