ea31886299
- remove Windows without WSL step
- update 'remote containers extension' to 'dev containers extension'
- remove invalid warning on directories creation
- simplify customizations section
- remove "publish a port" since it can be done at runtime now
- remove "run other services" since it's rather unneeded in this case
- expand documentation on custom welcome script and where to specify the bind mount
- use bullet points instead of subsections headings
48 lines
1.8 KiB
Markdown
48 lines
1.8 KiB
Markdown
# Development container
|
|
|
|
Development container that can be used with VSCode.
|
|
|
|
It works on Linux, Windows (WSL2) and OSX.
|
|
|
|
## Requirements
|
|
|
|
- [VS code](https://code.visualstudio.com/download) installed
|
|
- [VS code dev containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
|
|
- [Docker](https://www.docker.com/products/docker-desktop) installed and running
|
|
- [Docker Compose](https://docs.docker.com/compose/install/) installed
|
|
|
|
## Setup
|
|
|
|
1. Create the following files on your host if you don't have them:
|
|
|
|
```sh
|
|
touch ~/.gitconfig ~/.zsh_history
|
|
```
|
|
|
|
1. **For OSX hosts**: ensure your home directory `~` is accessible by Docker.
|
|
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
|
|
1. Select `Dev-Containers: Open Folder in Container...` and choose the project directory.
|
|
|
|
## Customization
|
|
|
|
For customizations to take effect, you should "rebuild and reopen":
|
|
|
|
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
|
|
2. Select `Dev-Containers: Rebuild Container`
|
|
|
|
Customizations available are notably:
|
|
|
|
- Changes to the Docker image in [Dockerfile](Dockerfile)
|
|
- Changes to VSCode **settings** and **extensions** in [devcontainer.json](devcontainer.json).
|
|
- Change the entrypoint script by adding in [docker-compose.yml](docker-compose.yml) a bind mount to a shell script to `/root/.welcome.sh` to replace the [current welcome script](https://github.com/qdm12/godevcontainer/blob/master/shell/.welcome.sh). For example:
|
|
|
|
```yml
|
|
volumes:
|
|
# ...
|
|
- ./.welcome.sh:/root/.welcome.sh:ro
|
|
# ...
|
|
```
|
|
|
|
- Change the docker container configuration in [docker-compose.yml](docker-compose.yml).
|
|
- More customizations available are documented in the [devcontainer.json reference](https://containers.dev/implementors/json_reference/).
|