admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(dev): minor fixes to devcontainer readme

Browse Source
This commit is contained in:
Quentin McGaw
2024-10-20 12:57:58 +00:00
parent a61302f135
commit bd8214e648
1 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
.devcontainer/README.md
View File

@@ -12,30 +12,32 @@ It works on Linux, Windows (WSL2) and OSX.
## Setup ## Setup
1. Create the following files on your host if you don't have them: 1. Create the following files and directory on your host if you don't have them:
```sh ```sh
touch ~/.gitconfig ~/.zsh_history touch ~/.gitconfig ~/.zsh_history
mkdir -p ~/.ssh
``` ```
1. **For OSX hosts**: ensure your home directory `~` is accessible by Docker. 1. **For Docker on OSX**: ensure the project directory and your home directory `~` are accessible by Docker.
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P). 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. 1. Select `Dev Containers: Open Folder in Container...` and choose the project directory.
## Customization ## Customization
For customizations to take effect, you should "rebuild and reopen": For any customization to take effect, you should "rebuild and reopen":
1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P) 1. Open the command palette in Visual Studio Code (CTRL+SHIFT+P)
2. Select `Dev-Containers: Rebuild Container` 2. Select `Dev Containers: Rebuild Container`
Customizations available are notably: Changes you can make are notably:
- Changes to the Docker image in [Dockerfile](Dockerfile) - Changes to the Docker image in [Dockerfile](Dockerfile)
- Changes to VSCode **settings** and **extensions** in [devcontainer.json](devcontainer.json). - Changes to VSCode **settings** and **extensions** in [devcontainer.json](devcontainer.json).
- Change the entrypoint script by adding in [devcontainer.json](devcontainer.json) 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: - Change the entrypoint script by adding a bind mount in [devcontainer.json](devcontainer.json) of 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:
```json ```json
// Welcome script
{ {
"source": "/yourpath/.welcome.sh", "source": "/yourpath/.welcome.sh",
"target": "/root/.welcome.sh", "target": "/root/.welcome.sh",
@@ -43,4 +45,4 @@ Customizations available are notably:
}, },
``` ```
- More customizations available are documented in the [devcontainer.json reference](https://containers.dev/implementors/json_reference/). - More options are documented in the [devcontainer.json reference](https://containers.dev/implementors/json_reference/).