87 lines
5.8 KiB
Markdown
87 lines
5.8 KiB
Markdown
# Try Out Development Containers: PHP
|
|
|
|
A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Remote - Containers](https://aka.ms/vscode-remote/containers)**.
|
|
|
|
This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
|
|
|
|
> **Note:** If you already have a Codespace or dev container, you can jump to the [Things to try](#things-to-try) section.
|
|
|
|
## Setting up the development container
|
|
|
|
### GitHub Codespaces
|
|
Follow these steps to open this sample in a Codespace:
|
|
1. Click the Code drop-down menu and select the **Open with Codespaces** option.
|
|
1. Select **+ New codespace** at the bottom on the pane.
|
|
|
|
For more info, check out the [GitHub documentation](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace#creating-a-codespace).
|
|
|
|
### VS Code Remote - Containers
|
|
Follow these steps to open this sample in a container using the VS Code Remote - Containers extension:
|
|
|
|
1. If this is your first time using a development container, please ensure your system meets the pre-reqs (i.e. have Docker installed) in the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started).
|
|
|
|
2. To use this repository, you can either open the repository in an isolated Docker volume:
|
|
|
|
- Press <kbd>F1</kbd> 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 the **Remote-Containers: Clone Repository in Container Volume...** command to clone the source code in a Docker volume instead of the local filesystem. [Volumes](https://docs.docker.com/storage/volumes/) are the preferred mechanism for persisting container data.
|
|
|
|
Or open a locally cloned copy of the code:
|
|
|
|
- Clone this repository to your local filesystem.
|
|
- Press <kbd>F1</kbd> 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!
|
|
|
|
## Things to try
|
|
|
|
Once you have this sample opened, 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 `"remoteUser": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root.
|
|
|
|
Some things to try:
|
|
|
|
1. **Edit:**
|
|
- Open `index.php`
|
|
- Try adding some code and check out the language features.
|
|
- Notice that PHP debugging and IntelliSense are already included in the container since the `.devcontainer/devcontainer.json` lists `"felixfbecker.php-debug"`, `"bmewburn.vscode-intelephense-client"`, and `"mrmlnc.vscode-apache"` as extensions to install automatically when the container is created.
|
|
1. **Terminal:** Press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
|
|
1. **Run and Debug:**
|
|
- Open `index.php`
|
|
- Add a breakpoint (e.g. on line 4).
|
|
- Press <kbd>F5</kbd> to launch the app in the container.
|
|
- Once the breakpoint is hit, try hovering over variables, examining locals, and more.
|
|
1. **Running a server:**
|
|
- From the terminal, run `php -S 0.0.0.0:8000`
|
|
- Click "Open in Browser" in the notification that appears to access the web app on this new port.
|
|
- You can view an organized table of your forwarded ports in the 'Ports' view, which can be accessed with the command **Ports: Focus on Ports View**.
|
|
- Notice port 8000 in the 'Ports' view is labeled "Hello Remote World." In `devcontainer.json`, you can set `"portsAttributes"`, such as a label for your forwarded ports and the action to be taken when the port is autoforwarded.
|
|
- Look back at the terminal, and you should see the output from your site navigations.
|
|
- Edit the text on line 21 in `index.php` and refresh the page to see the changes immediately take effect.
|
|
1. **Attach debugger to the server:**
|
|
- Follow the previous steps to start up a PHP server and open a browser on port `8000`
|
|
- Press <kbd>F1</kbd> and select the **View: Show Debug** command.
|
|
- Pick "Listen for XDebug" from the dropdown.
|
|
- Press <kbd>F5</kbd> to attach the debugger.
|
|
- Add a breakpoint to `index.php` if you haven't already.
|
|
- Reload your browser window.
|
|
- Once the breakpoint is hit, try hovering over variables, examining locals, and more.
|
|
|
|
## Contributing
|
|
|
|
This project welcomes contributions and suggestions. Most contributions require you to agree to a
|
|
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
|
|
the rights to use your contribution. For details, visit https://cla.microsoft.com.
|
|
|
|
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
|
|
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
|
|
provided by the bot. You will only need to do this once across all repos using our CLA.
|
|
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
|
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
|
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
|
|
|
## License
|
|
|
|
Copyright © Microsoft Corporation All rights reserved.<br />
|
|
Licensed under the MIT License. See LICENSE in the project root for license information.
|