|
| 1 | +# Code - OSS Development Container |
| 2 | + |
| 3 | +[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) |
| 4 | + |
| 5 | +This repository includes configuration for a development container for working with Code - OSS in a local container or using [GitHub Codespaces](https://github.com/features/codespaces). |
| 6 | + |
| 7 | +> **Tip:** The default VNC password is `vscode`. The VNC server runs on port `5901` and a web client is available on port `6080`. |
| 8 | +
|
| 9 | +## Quick start - local |
| 10 | + |
| 11 | +If you already have VS Code and Docker installed, you can click the badge above or [here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode) to get started. Clicking these links will cause VS Code to automatically install the Remote - Containers extension if needed, clone the source code into a container volume, and spin up a dev container for use. |
| 12 | + |
| 13 | +1. Install Docker Desktop or Docker for Linux on your local machine. (See [docs](https://aka.ms/vscode-remote/containers/getting-started) for additional details.) |
| 14 | + |
| 15 | +2. **Important**: Docker needs at least **4 Cores and 8 GB of RAM** to run a full build. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**. |
| 16 | + |
| 17 | + > **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar. |
| 18 | +
|
| 19 | +3. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the [Remote - Containers](https://aka.ms/vscode-remote/download/containers) extension. |
| 20 | + |
| 21 | +  |
| 22 | + |
| 23 | + > **Note:** The Remote - Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details. |
| 24 | +
|
| 25 | +4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Remote-Containers: Clone Repository in Container Volume...**. |
| 26 | + |
| 27 | + > **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem. |
| 28 | +
|
| 29 | +5. Type `https://github.com/microsoft/vscode` (or a branch or PR URL) in the input box and press <kbd>Enter</kbd>. |
| 30 | + |
| 31 | +6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password. |
| 32 | + |
| 33 | +Anything you start in VS Code, or the integrated terminal, will appear here. |
| 34 | + |
| 35 | +Next: **[Try it out!](#try-it)** |
| 36 | + |
| 37 | +## Quick start - GitHub Codespaces |
| 38 | + |
| 39 | +1. From the [microsoft/vscode GitHub repository](https://github.com/microsoft/vscode), click on the **Code** dropdown, select **Open with Codespaces**, and then click on **New codespace**. If prompted, select the **Standard** machine size (which is also the default). |
| 40 | + |
| 41 | + > **Note:** You will not see these options within GitHub if you are not in the Codespaces beta. |
| 42 | +
|
| 43 | +2. After the codespace is up and running in your browser, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Ports: Focus on Ports View**. |
| 44 | + |
| 45 | +3. You should see **VNC web client (6080)** under in the list of ports. Select the line and click on the globe icon to open it in a browser tab. |
| 46 | + |
| 47 | + > **Tip:** If you do not see the port, <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, select **Forward a Port** and enter port `6080`. |
| 48 | +
|
| 49 | +4. In the new tab, you should see noVNC. Click **Connect** and enter `vscode` as the password. |
| 50 | + |
| 51 | +Anything you start in VS Code, or the integrated terminal, will appear here. |
| 52 | + |
| 53 | +Next: **[Try it out!](#try-it)** |
| 54 | + |
| 55 | +### Using VS Code with GitHub Codespaces |
| 56 | + |
| 57 | +You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Here's how to do it. |
| 58 | + |
| 59 | +1. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces). |
| 60 | + |
| 61 | + > **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS. |
| 62 | +
|
| 63 | +2. After the VS Code is up and running, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, choose **Codespaces: Create New Codespace**, and use the following settings: |
| 64 | + - `microsoft/vscode` for the repository. |
| 65 | + - Select any branch (e.g. **main**) - you can select a different one later. |
| 66 | + - Choose **Standard** (4-core, 8GB) as the size. |
| 67 | + |
| 68 | +4. After you have connected to the codespace, you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password. |
| 69 | + |
| 70 | + > **Tip:** You may also need change your VNC client's **Picture Quality** setting to **High** to get a full color desktop. |
| 71 | +
|
| 72 | +5. Anything you start in VS Code, or the integrated terminal, will appear here. |
| 73 | + |
| 74 | +Next: **[Try it out!](#try-it)** |
| 75 | + |
| 76 | +## Try it! |
| 77 | + |
| 78 | +This container uses the [Fluxbox](http://fluxbox.org/) window manager to keep things lean. **Right-click on the desktop** to see menu options. It works with GNOME and GTK applications, so other tools can be installed if needed. |
| 79 | + |
| 80 | +> **Note:** You can also set the resolution from the command line by typing `set-resolution`. |
| 81 | +
|
| 82 | +To start working with Code - OSS, follow these steps: |
| 83 | + |
| 84 | +1. In your local VS Code client, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands: |
| 85 | + |
| 86 | + ```bash |
| 87 | + yarn install |
| 88 | + bash scripts/code.sh |
| 89 | + ``` |
| 90 | + |
| 91 | +2. After the build is complete, open a web browser or a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to the desktop environment as described in the quick start and enter `vscode` as the password. |
| 92 | + |
| 93 | +3. You should now see Code - OSS! |
| 94 | + |
| 95 | +Next, let's try debugging. |
| 96 | +
|
| 97 | +1. Shut down Code - OSS by clicking the box in the upper right corner of the Code - OSS window through your browser or VNC viewer. |
| 98 | +
|
| 99 | +2. Go to your local VS Code client, and use the **Run / Debug** view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>). |
| 100 | +
|
| 101 | + > **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues. |
| 102 | +
|
| 103 | +3. After a bit, Code - OSS will appear with the debugger attached! |
| 104 | +
|
| 105 | +Enjoy! |
0 commit comments