Skip to content

Commit 05f19da

Browse files
authored
docs: update docker dev instructions
1 parent 68684be commit 05f19da

1 file changed

Lines changed: 7 additions & 8 deletions

File tree

docker/README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This project includes a devcontainer configuration which automates the setup of
2727
### Initial Setup
2828

2929
1. Launch [VS Code](https://code.visualstudio.com/)
30-
2. Under the **Extensions** tab, install the **Remote - Containers** ([ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)) extension installed. On Windows, you also need the **Remote - WSL** ([ms-vscode-remote.remote-wsl](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)) extension to take advantage of the WSL 2 *(Windows Subsystem for Linux)* native integration.
30+
2. Under the **Extensions** tab, ensure you have the **Remote - Containers** ([ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)) extension installed. On Windows, you also need the **Remote - WSL** ([ms-vscode-remote.remote-wsl](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl)) extension to take advantage of the WSL 2 *(Windows Subsystem for Linux)* native integration.
3131
2. Open the top-level directory of the datatracker code you fetched above.
3232
3. A prompt inviting you to reopen the project in containers will appear in the bottom-right corner. Click the **Reopen in Container** button. If you missed the prompt, you can press `F1`, start typing `reopen in container` task and launch it.
3333
4. VS Code will relaunch in the dev environment and create the containers automatically.
@@ -37,7 +37,7 @@ This project includes a devcontainer configuration which automates the setup of
3737

3838
To return to your dev environment created above, simply open **VS Code** and select **File** > **Open Recent** and select the datatracker folder with the `[Dev Container]` suffix.
3939

40-
You can also open the datatracker project folder and click the **Reopen in container** button when prompted. f you missed the prompt, you can press `F1`, start typing `reopen in container` task and launch it.
40+
You can also open the datatracker project folder and click the **Reopen in container** button when prompted. If you missed the prompt, you can press `F1`, start typing `reopen in container` task and launch it.
4141

4242
### Usage
4343

@@ -87,10 +87,11 @@ You can also open the datatracker project folder and click the **Reopen in conta
8787
run
8888
```
8989
90-
On Windows:
90+
On Windows *(using Powershell)*:
9191
```sh
92-
cd docker
93-
docker-compose -f docker-compose.yml -f docker-compose.extend.yml up -d
92+
Copy-Item "docker/docker-compose.extend.yml" -Destination "docker/docker-compose.extend-custom.yml"
93+
(Get-Content -path docker/docker-compose.extend-custom.yml -Raw) -replace 'CUSTOM_PORT','8000' | Set-Content -Path docker/docker-compose.extend-custom.yml
94+
docker-compose -f docker-compose.yml -f docker/docker-compose.extend-custom.yml up -d
9495
docker-compose exec app /bin/sh /docker-init.sh
9596
```
9697
@@ -112,7 +113,7 @@ To exit the dev environment, simply enter command `exit` in the shell.
112113
113114
The containers will automatically be shut down on Linux / macOS.
114115
115-
On Windows, type the command (from the `docker/` directory)
116+
On Windows, type the command
116117
117118
```sh
118119
docker-compose down
@@ -133,7 +134,6 @@ cleandb
133134
134135
On Windows:
135136
```sh
136-
cd docker
137137
docker-compose down -v
138138
docker-compose pull db
139139
docker-compose build --no-cache db
@@ -152,7 +152,6 @@ cleanall
152152
153153
On Windows:
154154
```sh
155-
cd docker
156155
docker-compose down -v --rmi all
157156
docker image prune
158157
```

0 commit comments

Comments
 (0)