diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index 6ff3dc9..53dad04 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -8,7 +8,10 @@ FROM php:7-cli # Avoid warnings by switching to noninteractive ENV DEBIAN_FRONTEND=noninteractive -# Or your actual UID, GID on Linux if not the default 1000 +# This Dockerfile adds 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=vscode ARG USER_UID=1000 ARG USER_GID=$USER_UID @@ -17,8 +20,8 @@ ARG USER_GID=$USER_UID RUN apt-get update \ && apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \ # - # Install git, procps, lsb-release (useful for CLI installs) - && apt-get -y install git procps iproute2 lsb-release \ + # install git iproute2, procps, lsb-release (useful for CLI installs) + && apt-get -y install git iproute2 procps iproute2 lsb-release \ # # Install xdebug && yes | pecl install xdebug \ @@ -29,9 +32,9 @@ RUN apt-get update \ # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user. && groupadd --gid $USER_GID $USERNAME \ && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \ - # [Optional] Add sudo support for non-root user + # [Optional] Add sudo support for the non-root user && apt-get install -y sudo \ - && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME \ + && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\ && chmod 0440 /etc/sudoers.d/$USERNAME \ # # Clean up @@ -40,6 +43,5 @@ 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 diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 03b2f2a..3f9cce6 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,25 +1,26 @@ { - "name": "PHP", + "name": "PHP Sample", "dockerFile": "Dockerfile", - - // 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", "vscode"], // 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. - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" + "settings": { + "terminal.integrated.shell.linux": "/bin/bash" }, - - // Uncomment the next line if you want to publish any ports. + + // 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": [], // Uncomment the next line to run commands after the container is created. // "postCreateCommand": "php -v", + // Comment out if you want to use root + "remoteUser": "vscode", + + // Add the IDs of extensions you want installed when the container is created in the array below. "extensions": [ - "felixfbecker.php-debug", - "felixfbecker.php-intellisense" - ] -} \ No newline at end of file + "felixfbecker.php-debug", + "felixfbecker.php-intellisense" + ] +} diff --git a/README.md b/README.md index 48af4a0..b6742fa 100644 --- a/README.md +++ b/README.md @@ -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` 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 "PHP" 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", "vscode"]` 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": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root. Some things to try: