Merge pull request #23 from microsoft/ports
Update ports properties and README
This commit is contained in:
@@ -21,17 +21,22 @@
|
||||
// Use 'forwardPorts' to make a list of ports inside the container available locally.
|
||||
// "forwardPorts": [3000],
|
||||
|
||||
// Use 'postCreateCommand' to run commands after the container is created.
|
||||
"postCreateCommand": "yarn install",
|
||||
|
||||
// Use 'portsAttributes' to set default properties for specific forwarded ports.
|
||||
// You can use a port number (i.e. 3000), range of numbers, or a regex to match the running process.
|
||||
"portsAttributes": {
|
||||
"3000": {
|
||||
"label": "Hello Remote World",
|
||||
"onAutoForward": "notify"
|
||||
".+/server.js": {
|
||||
"label": "Hello Remote World"
|
||||
}
|
||||
},
|
||||
|
||||
// Use 'otherPortsAttributes' to configure any ports that aren't configured using 'portsAttributes'.
|
||||
// "otherPortsAttributes": {
|
||||
// "onAutoForward": "silent"
|
||||
// },
|
||||
|
||||
// Use 'postCreateCommand' to run commands after the container is created.
|
||||
"postCreateCommand": "yarn install",
|
||||
|
||||
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
|
||||
"remoteUser": "node"
|
||||
}
|
||||
|
||||
@@ -61,12 +61,10 @@ Some things to try:
|
||||
|
||||
You may want to make changes to your container, such as installing a different version of a software or forwarding a new port. You'll rebuild your container for your changes to take effect.
|
||||
|
||||
**Forward a port statically:** As an example change, let's forward a port statically in the `.devcontainer/devcontainer.json` file.
|
||||
|
||||
> **Note:** Remote-Containers and Codespaces also take care of dynamic port forwarding, but there may be instances in which we want to statically declare a forwarded port.
|
||||
**Forward a port statically:** As an example change, let's update the `portsAttributes` in the `.devcontainer/devcontainer.json` file to open a browser when our port is automatically forwarded.
|
||||
|
||||
- Open the `.devcontainer/devcontainer.json` file.
|
||||
- Uncomment the `forwardedPorts` attribute and adjust the port number as needed.
|
||||
- Modify your `portsAttributes` to include a new attribute (you can add it underneath the `label` attribute): `"onAutoForward": "openBrowser"`.
|
||||
- Press <kbd>F1</kbd> and select the **Remote-Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up.
|
||||
|
||||
## Contributing
|
||||
|
||||
Reference in New Issue
Block a user