Skip to content

Commit a38b6c1

Browse files
authored
docs: update docker/README.md
1 parent 8e439df commit a38b6c1

1 file changed

Lines changed: 6 additions & 10 deletions

File tree

docker/README.md

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can also open the datatracker project folder and click the **Reopen in conta
4545

4646
### Usage
4747

48-
- Under the **Run and Debug** tab, you can run the server with the debugger attached using **Run Server** (F5). Once the server is ready to accept connections, you'll be prompted to open in a browser. You can also open [http://localhost:8000](http://localhost:8000) in a browser.
48+
- Under the **Run and Debug** tab, you can run the server with the debugger attached using **Run Server** (F5). Once the server is ready to accept connections, you'll be prompted to open in a browser. Navigate to [http://localhost:8000](http://localhost:8000) in your preferred browser.
4949
5050
> An alternate profile **Run Server with Debug Toolbar** is also available from the dropdown menu, which displays various tools
5151
on top of the webpage. However, note that this configuration has a significant performance impact.
@@ -64,11 +64,7 @@ You can also open the datatracker project folder and click the **Reopen in conta
6464
6565
![](assets/vscode-terminal-new.png)
6666
67-
- Under the **SQL Tools** tab, a connection **Local Dev** is preconfigured to connect to the DB container. Using this tool, you can list tables, view records and execute SQL queries directly from VS Code.
68-
69-
> The port `3306` is also exposed to the host automatically, should you prefer to use your own SQL tool.
70-
71-
![](assets/vscode-sqltools.png)
67+
- The pgAdmin web interface, a PostgreSQL DB browser / management UI, is available at [http://localhost:8000/pgadmin/](http://localhost:8000/pgadmin/).
7268
7369
- Under the **Task Explorer** tab, a list of available preconfigured tasks is displayed. *(You may need to expand the tree to `src > vscode` to see it.)* These are common scritps you can run *(e.g. run tests, fetch assets, etc.)*.
7470
@@ -103,7 +99,7 @@ You can also open the datatracker project folder and click the **Reopen in conta
10399
2. Wait for the containers to initialize. Upon completion, you will be dropped into a shell from which you can start the datatracker and execute related commands as usual, for example
104100

105101
```
106-
ietf/manage.py runserver 0.0.0.0:8000
102+
ietf/manage.py runserver 0.0.0.0:8001
107103
```
108104

109105
to start the datatracker.
@@ -161,11 +157,11 @@ docker compose down -v --rmi all
161157
docker image prune
162158
```
163159

164-
### Accessing MariaDB Port
160+
### Accessing PostgreSQL Port
165161

166-
The port is exposed but not mapped to `3306` to avoid potential conflicts with the host. To get the mapped port, run the command *(from the project `/docker` directory)*:
162+
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)*:
167163
```sh
168-
docker compose port db 3306
164+
docker compose port db 5432
169165
```
170166

171167
## Notes / Troubleshooting

0 commit comments

Comments
 (0)