diff options
| author | github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> | 2022-11-12 22:24:57 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-12 22:24:57 +0300 |
| commit | 0e258004862f3c4e33da3138e65bc82036cf768f (patch) | |
| tree | 9badcf03501160ecf5bf6bd3366b7743f99b9271 /src/nix | |
| parent | e9c4f9f8c5404d50a6120ff2228f0c34c5d70148 (diff) | |
Automated documentation update (#282)
Automated documentation update [skip ci]
Co-authored-by: github-actions <github-actions@github.com>
Diffstat (limited to 'src/nix')
| -rw-r--r-- | src/nix/README.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/nix/README.md b/src/nix/README.md index dcbc9a1..4d0e1ad 100644 --- a/src/nix/README.md +++ b/src/nix/README.md @@ -40,7 +40,7 @@ This Dev Container Feature supports two installation models for Nix: multi-user | Installation Model | Pros | Cons | | --- | --- | --- | | *Multi-User* | Nix can be used with any user including root.<br /><br />Also still works if the UID or GID of any user is updated. | Only works with Nix 2.11 and up due to a Nix installer limitation.<br /><br />Container must run either: run as root (but `remoteUser` in devcontainer.json can be non-root), or includes `sudo` with the `remoteUser` being configured to use it. <br /><br />Note that automated start of the `nix-daemon` requires passwordless `sudo` if the container itself (e.g., `containerUser`) is not running as root. Manual startup using `sudo` can require a password, however (more next). | -| *Single-User* | Does not require the container to run as root or `sudo` to be included in the image. | Only works with the user specified in the `userName` property or an auto-detected user. If this user's UID/GID is updated, that user will no longer be able to work with Nix. This is primarily a consideration when running on Linux where the UID/GID is sync'd to the local user. | +| *Single-User* | Does not require the container to run as root or `sudo` to be included in the image. | Only works with the user specified in the `remoteUser` property or an auto-detected user. If this user's UID/GID is updated, that user will no longer be able to work with Nix. This is primarily a consideration when running on Linux where the UID/GID is sync'd to the local user. | ### Manually starting the Nix daemon @@ -52,6 +52,7 @@ sudo /usr/local/share/nix-entrypoint.sh This same command can be used to restart the daemon if it has stopped for some reason. Logs are available at `/tmp/nix-daemon.log`. + --- _Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/devcontainers/features/blob/main/src/nix/devcontainer-feature.json). Add additional notes to a `NOTES.md`._ |