From 96b3f736c84f2fbad84e8dbfbbcdeb9febdd7bcb Mon Sep 17 00:00:00 2001 From: Samuel K Date: Mon, 19 Oct 2026 08:15:54 -0600 Subject: [PATCH 1/2] docs(secrets): correct unverified claims on secrets page --- .../docs/developing-in-workspaces/secrets.mdx | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx index 86a56105d1..75ceead6a7 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx @@ -12,7 +12,7 @@ Both use the same delivery paths: environment variables for lifecycle commands, ## Devsy-managed secrets -Secrets are scoped to the active context. With the default `auto` backend, Devsy uses the OS keyring when there is one (Keychain, Credential Manager, or Secret Service on Linux). Otherwise it uses an age-encrypted `secrets.enc` file in the Devsy config directory. Only metadata such as names and timestamps is stored in plaintext. +Secrets are scoped to the active context. With the default `auto` backend, Devsy uses the OS keyring when there is one (Keychain, Credential Manager, or libsecret on Linux). Otherwise it uses an age-encrypted `secrets.enc` file in the Devsy config directory. Only metadata such as names and timestamps is stored in plaintext. ```shell devsy secret set DB_PASSWORD # hidden prompt @@ -66,7 +66,7 @@ Paths are relative to the repository root. Paths that escape it, including throu ### Credentials for SOPS -Devsy uses SOPS key discovery. For age, set `SOPS_AGE_KEY` or `SOPS_AGE_KEY_FILE`, or use the standard age key location. For AWS KMS, GCP KMS, Azure Key Vault and PGP, use the same configuration you would use with SOPS. +For age keys, set `SOPS_AGE_KEY` in the environment of the `devsy` process. ## Referencing secrets @@ -91,7 +91,7 @@ devsy workspace up . --secret sops:project/DATABASE_PASSWORD,target=DB_PASSWORD devsy workspace up . --secret sops:project/TLS_KEY,type=mount,target=tls.key ``` -The file is `/run/secrets/tls.key`. Providers without an in-memory mount return an error. +The file is `/run/secrets/tls.key`. ### Build secrets @@ -111,9 +111,7 @@ devsy secret attach sops:project/API_TOKEN devsy secret detach DB_PASSWORD ``` -Devsy stores only the reference. Running sessions keep their current environment. After detaching, run `workspace up` or recreate the workspace so new sessions lose the value. - -If names collide, a session uses the first of: explicit session environment (`workspace ssh --set-env`), attached secret, the container's own environment. +Devsy stores only the reference. Attach and detach take effect on the next `workspace up`; running sessions keep their current environment. ### Where each kind is available @@ -170,7 +168,7 @@ devsy secret protection remember devsy secret protection forget ``` -`forget` removes the saved credential; secrets stay encrypted. In Desktop, use **Manage security** on the **Secrets** tab. Changing protection asks for confirmation in a native dialog. +`forget` removes the saved credential; secrets stay encrypted. In Desktop, use **Manage security** on the **Secrets** tab. Changing protection asks for confirmation in an in-app dialog. ### Recovery @@ -184,7 +182,7 @@ The command lists every file-backed secret across all contexts and asks you to t ## Managed environment variables -For non-sensitive settings, `devsy env` stores plaintext values in `env.yaml`, separate from secrets, and works while the secret store is locked. Do not store sensitive values here. +For non-sensitive settings, `devsy env` stores plaintext values in `env.yaml`, separate from secrets. `set`, `get`, `list` and `delete` do not use the secret store. Do not store sensitive values here. ```shell devsy env set LOG_LEVEL=debug @@ -202,11 +200,11 @@ devsy workspace up ... --env LOG_LEVEL --env REGION=AWS_REGION `--env` takes managed environment variables only. Use `--secret` for sensitive values. -Attach a variable to the context to inject it on every start or recreate: +Attach a variable to the context to inject it on every `workspace up`: ```shell devsy env attach LOG_LEVEL devsy env detach LOG_LEVEL ``` -An explicit `--env` with a target overrides the attachment for that run. Attaching or detaching affects the next start, not a running workspace. Deleting a value also removes its attachment. +Attaching or detaching affects the next `workspace up`, not a running workspace. Deleting a value also removes its attachment. From 17cf50210a5166cd231503c805d8e5dbe37d3fa3 Mon Sep 17 00:00:00 2001 From: Samuel K Date: Mon, 19 Oct 2026 08:58:15 -0600 Subject: [PATCH 2/2] docs(secrets): correct --env attachment override wording An explicit --env overrides an attached variable by name, not by target. Restore the rest of the page to the base text, which was not shown to be wrong. --- .../docs/developing-in-workspaces/secrets.mdx | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx index 75ceead6a7..4725de0684 100644 --- a/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx +++ b/sites/docs-devsy-sh/content/docs/developing-in-workspaces/secrets.mdx @@ -12,7 +12,7 @@ Both use the same delivery paths: environment variables for lifecycle commands, ## Devsy-managed secrets -Secrets are scoped to the active context. With the default `auto` backend, Devsy uses the OS keyring when there is one (Keychain, Credential Manager, or libsecret on Linux). Otherwise it uses an age-encrypted `secrets.enc` file in the Devsy config directory. Only metadata such as names and timestamps is stored in plaintext. +Secrets are scoped to the active context. With the default `auto` backend, Devsy uses the OS keyring when there is one (Keychain, Credential Manager, or Secret Service on Linux). Otherwise it uses an age-encrypted `secrets.enc` file in the Devsy config directory. Only metadata such as names and timestamps is stored in plaintext. ```shell devsy secret set DB_PASSWORD # hidden prompt @@ -66,7 +66,7 @@ Paths are relative to the repository root. Paths that escape it, including throu ### Credentials for SOPS -For age keys, set `SOPS_AGE_KEY` in the environment of the `devsy` process. +Devsy uses SOPS key discovery. For age, set `SOPS_AGE_KEY` or `SOPS_AGE_KEY_FILE`, or use the standard age key location. For AWS KMS, GCP KMS, Azure Key Vault and PGP, use the same configuration you would use with SOPS. ## Referencing secrets @@ -91,7 +91,7 @@ devsy workspace up . --secret sops:project/DATABASE_PASSWORD,target=DB_PASSWORD devsy workspace up . --secret sops:project/TLS_KEY,type=mount,target=tls.key ``` -The file is `/run/secrets/tls.key`. +The file is `/run/secrets/tls.key`. Providers without an in-memory mount return an error. ### Build secrets @@ -111,7 +111,9 @@ devsy secret attach sops:project/API_TOKEN devsy secret detach DB_PASSWORD ``` -Devsy stores only the reference. Attach and detach take effect on the next `workspace up`; running sessions keep their current environment. +Devsy stores only the reference. Running sessions keep their current environment. After detaching, run `workspace up` or recreate the workspace so new sessions lose the value. + +If names collide, a session uses the first of: explicit session environment (`workspace ssh --set-env`), attached secret, the container's own environment. ### Where each kind is available @@ -168,7 +170,7 @@ devsy secret protection remember devsy secret protection forget ``` -`forget` removes the saved credential; secrets stay encrypted. In Desktop, use **Manage security** on the **Secrets** tab. Changing protection asks for confirmation in an in-app dialog. +`forget` removes the saved credential; secrets stay encrypted. In Desktop, use **Manage security** on the **Secrets** tab. Changing protection asks for confirmation in a native dialog. ### Recovery @@ -182,7 +184,7 @@ The command lists every file-backed secret across all contexts and asks you to t ## Managed environment variables -For non-sensitive settings, `devsy env` stores plaintext values in `env.yaml`, separate from secrets. `set`, `get`, `list` and `delete` do not use the secret store. Do not store sensitive values here. +For non-sensitive settings, `devsy env` stores plaintext values in `env.yaml`, separate from secrets, and works while the secret store is locked. Do not store sensitive values here. ```shell devsy env set LOG_LEVEL=debug @@ -200,11 +202,11 @@ devsy workspace up ... --env LOG_LEVEL --env REGION=AWS_REGION `--env` takes managed environment variables only. Use `--secret` for sensitive values. -Attach a variable to the context to inject it on every `workspace up`: +Attach a variable to the context to inject it on every start or recreate: ```shell devsy env attach LOG_LEVEL devsy env detach LOG_LEVEL ``` -Attaching or detaching affects the next `workspace up`, not a running workspace. Deleting a value also removes its attachment. +An explicit `--env` for the same name overrides the attachment for that run. Attaching or detaching affects the next start, not a running workspace. Deleting a value also removes its attachment.