Files

Quentin McGaw ea31886299 docs(devcontainer): update readme

- 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

2024-10-10 08:33:33 +00:00

.dockerignore

Dev container documentation and cleanup

2020-12-08 06:24:46 +00:00

devcontainer.json

chore(dev): upgrade organizeImports vscode setting from true to explicit

2024-08-05 13:39:01 +00:00

docker-compose.yml

chore(dev): update devcontainer definitions

2023-05-29 15:57:09 +00:00

Dockerfile

chore(dev): add openssl to dev container

2023-04-03 10:41:37 +00:00

README.md

docs(devcontainer): update readme

2024-10-10 08:33:33 +00:00

README.md

Development container

Development container that can be used with VSCode.

It works on Linux, Windows (WSL2) and OSX.

Requirements

VS code installed
VS code dev containers extension installed
Docker installed and running
Docker Compose installed

Setup

Create the following files on your host if you don't have them:
```
touch ~/.gitconfig ~/.zsh_history
```
For OSX hosts: ensure your home directory ~ is accessible by Docker.
Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
Select Dev-Containers: Open Folder in Container... and choose the project directory.

Customization

For customizations to take effect, you should "rebuild and reopen":

Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
Select Dev-Containers: Rebuild Container

Customizations available are notably:

Changes to the Docker image in Dockerfile
Changes to VSCode settings and extensions in devcontainer.json.
Change the entrypoint script by adding in docker-compose.yml a bind mount to a shell script to /root/.welcome.sh to replace the current welcome script. For example:
```
volumes:
  # ...
  - ./.welcome.sh:/root/.welcome.sh:ro
  # ...
```
Change the docker container configuration in docker-compose.yml.
More customizations available are documented in the devcontainer.json reference.