diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 98e0f0b..3ad2ed3 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -5,22 +5,23 @@ FROM node:10 -# Avoid warnings by switching to noninteractive -ENV DEBIAN_FRONTEND=noninteractive - -# The node image comes with a base non-root 'node' user which this Dockerfile -# gives sudo access. However, for Linux, this user's GID/UID must match your local -# user UID/GID to avoid permission issues with bind mounts. Update USER_UID / USER_GID -# if yours is not 1000. See https://aka.ms/vscode-remote/containers/non-root-user. +# The node image includes a non-root user with sudo access. Use the "remoteUser" +# property in devcontainer.json to use it. On Linux, the container user's GID/UIDs +# will be updated to match your local UID/GID (when using the dockerFile property). +# See https://aka.ms/vscode-remote/containers/non-root-user for details. +ARG USERNAME=node ARG USER_UID=1000 ARG USER_GID=$USER_UID +# Avoid warnings by switching to noninteractive +ENV DEBIAN_FRONTEND=noninteractive + # Configure apt and install packages RUN apt-get update \ && apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \ # # Verify git and needed tools are installed - && apt-get install -y git procps \ + && apt-get -y install git iproute2 procps \ # # Remove outdated yarn from /opt and install via package # so it can be easily updated via apt-get upgrade yarn @@ -36,13 +37,16 @@ RUN apt-get update \ # Install eslint globally && npm install -g eslint \ # - # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user. - && if [ "$USER_GID" != "1000" ]; then groupmod node --gid $USER_GID; fi \ - && if [ "$USER_UID" != "1000" ]; then usermod --uid $USER_UID node; fi \ - # [Optional] Add sudo support for non-root users + # [Optional] Update a non-root user to UID/GID if needed. + && if [ "$USER_GID" != "1000" ] || [ "$USER_UID" != "1000" ]; then \ + groupmod --gid $USER_GID $USERNAME \ + && usermod --uid $USER_UID --gid $USER_GID $USERNAME \ + && chown -R $USER_UID:$USER_GID /home/$USERNAME; \ + fi \ + # [Optional] Add add sudo support for non-root user && apt-get install -y sudo \ - && echo node ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/node \ - && chmod 0440 /etc/sudoers.d/node \ + && echo node ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \ + && chmod 0440 /etc/sudoers.d/$USERNAME \ # # Clean up && apt-get autoremove -y \ @@ -50,4 +54,4 @@ RUN apt-get update \ && rm -rf /var/lib/apt/lists/* # Switch back to dialog for any ad-hoc use of apt-get -ENV DEBIAN_FRONTEND= +ENV DEBIAN_FRONTEND=dialog \ No newline at end of file diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 057b034..a019a3c 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -2,12 +2,12 @@ "name": "Node.js Sample", "dockerFile": "Dockerfile", - // Specifies a list of ports that should be published. + // Use 'appPort' to create a container with published ports. If the port isn't working, be sure + // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost. "appPort": [3000], - // Comment out the next line to run as root instead. Linux users, update - // Dockerfile with your user's UID/GID if not 1000. - "runArgs": [ "-u", "node" ], + // Comment out the next line to run as root instead. + "remoteUser": "node", // Use 'settings' to set *default* container specific settings.json values on container create. // You can edit these settings after create using File > Preferences > Settings > Remote. @@ -18,6 +18,7 @@ // Specifies a command that should be run after the container has been created. "postCreateCommand": "yarn install", + // Add the IDs of extensions you want installed when the container is created in the array below. "extensions": [ "dbaeumer.vscode-eslint" ] diff --git a/README.md b/README.md index f7cbb78..9b5f010 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This is a sample project that lets you try out the **[VS Code Remote - Containers](https://aka.ms/vscode-remote/containers)** extension in a few easy steps. -> **Note:** If you're following the quick start, you can jump to the [Things to try](#things-to-try) section. +> **Note:** If you're following the quick start, you can jump to the [Things to try](#things-to-try) section. ## Setting up the development container @@ -10,18 +10,23 @@ Follow these steps to open this sample in a container: 1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started). -2. **Linux users:** Update `USER_UID` and `USER_GID` in `.devcontainer/Dockerfile` and `"runArgs": [ "-u": "1000" ]` in `.devcontainer/devcontainer.json` with your user UID/GID if not 1000 to avoid creating files as root. +2. To use this repository, you can either open a locally cloned copy of the code: -3. If you're not yet in a development container: - - Clone this repository. + - Clone this repository to your local filesystem. - Press F1 and select the **Remote-Containers: Open Folder in Container...** command. - Select the cloned copy of this folder, wait for the container to start, and try things out! + Or open the repository in an isolated Docker volume: + + - Press F1 and select the **Remote-Containers: Try a Sample...** command. + - Choose the "Node" sample, wait for the container to start and try things out! + > **Note:** Under the hood, this will use **Remote-Containers: Open Repository in Container...** command to clone the source code in a Docker volume instead of the local filesystem. + ## Things to try Once you have this sample opened in a container, you'll be able to work with it like you would locally. -> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"runArgs":["-u", "1000"]` in `.devcontainer/devcontainer.json` if you'd prefer to run as root. +> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"remoteUser": "node"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root. Some things to try: