admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ea31886299f065c4a236f1bae6b8b242d7bafddd
gluetun/.devcontainer/README.md

48 lines
1.8 KiB
Markdown
Raw Normal View History

Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
# Development container
Development container that can be used with VSCode.
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
It works on Linux, Windows (WSL2) and OSX.
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
## Requirements
- [VS code](https://code.visualstudio.com/download) installed
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
- [VS code dev containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
- [Docker](https://www.docker.com/products/docker-desktop) installed and running
- [Docker Compose](https://docs.docker.com/compose/install/) installed
## Setup
chore(dev): update devcontainer definitions
2023-05-29 15:57:09 +00:00
1. Create the following files on your host if you don't have them:
```sh
touch ~/.gitconfig ~/.zsh_history
```
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
1. **For OSX hosts**: ensure your home directory `~` is accessible by Docker.
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P).
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
1. Select `Dev-Containers: Open Folder in Container...` and choose the project directory.
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
## Customization
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
For customizations to take effect, you should "rebuild and reopen":
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
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
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
2. Select `Dev-Containers: Rebuild Container`
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
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
Customizations available are notably:
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
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
- 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:
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
```yml
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
volumes:
# ...
- ./.welcome.sh:/root/.welcome.sh:ro
# ...
Dev container documentation and cleanup
2020-12-08 06:24:46 +00:00
```
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
- 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/).
Reference in New Issue Copy Permalink