Skip to content

Commit 3241d57

Browse files
authored
docs: Update README.md
1 parent 75f6945 commit 3241d57

1 file changed

Lines changed: 23 additions & 10 deletions

File tree

docker/README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Datatracker Development in Docker
22

3+
- [Getting started](#getting-started)
4+
- [Using Visual Studio Code](#using-visual-studio-code)
5+
- [Initial Setup](#initial-setup)
6+
- [Subsequent Launch](#subsequent-launch)
7+
- [Usage](#usage)
8+
- [Using Other Editors / Generic](#using-other-editors--generic)
9+
- [Exit Environment](#exit-environment)
10+
- [Accessing PostgreSQL Port](#accessing-postgresql-port)
11+
- [Clean and Rebuild DB from latest image](#clean-and-rebuild-db-from-latest-image)
12+
- [Clean all](#clean-all)
13+
- [Updating an older environment](#updating-an-older-environment)
14+
- [Notes / Troubleshooting](#notes--troubleshooting)
15+
316
## Getting started
417

518
1. [Set up Docker](https://docs.docker.com/get-started/) on your preferred platform. On Windows, it is highly recommended to use the [WSL 2 *(Windows Subsystem for Linux)*](https://docs.docker.com/desktop/windows/wsl/) backend.
@@ -123,7 +136,14 @@ docker compose down
123136

124137
to terminate the containers.
125138

126-
### Clean and Rebuild DB from latest image
139+
### Accessing PostgreSQL Port
140+
141+
The port is exposed but not automatically mapped to `5432` to avoid potential conflicts with the host. To get the mapped port, run the command *(from the project `/docker` directory)*:
142+
```sh
143+
docker compose port db 5432
144+
```
145+
146+
## Clean and Rebuild DB from latest image
127147

128148
To delete the active DB container, its volume and get the latest image / DB dump, simply run the following command:
129149

@@ -141,7 +161,7 @@ docker compose pull db
141161
docker compose build --no-cache db
142162
```
143163

144-
### Clean all
164+
## Clean all
145165

146166
To delete all containers for this project, its associated images and purge any remaining dangling images, simply run the following command:
147167

@@ -158,7 +178,7 @@ docker compose down -v --rmi all
158178
docker image prune
159179
```
160180

161-
### Updating an older environment
181+
## Updating an older environment
162182

163183
If you already have a clone, such as from a previous codesprint, and are updating that clone, before starting the datatracker from the updated image:
164184
1. `rm ietf/settings_local.py` *(The startup script will put a new one, appropriate to the current release, in place)*
@@ -173,13 +193,6 @@ If the dev environment fails to start, even after running the [Clean all](#clean
173193
docker system prune -a --volumes
174194
```
175195

176-
### Accessing PostgreSQL Port
177-
178-
The port is exposed but not automatically mapped to `5432` to avoid potential conflicts with the host. To get the mapped port, run the command *(from the project `/docker` directory)*:
179-
```sh
180-
docker compose port db 5432
181-
```
182-
183196
## Notes / Troubleshooting
184197

185198
### Slow zsh prompt inside Docker

0 commit comments

Comments
 (0)