Skip to content

Commit

Permalink
docs: update info about interactive api debugging port
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Jan 18, 2024
1 parent ed95c47 commit 4d7ba07
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/dev/Backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,20 @@ alembic upgrade head
To use it:

1. Re-build the docker image `docker compose build api`
2. Start the docker container `docker compose up -d api`
3. Connect to the debugger on port **5678**.
2. Uncomment the debug port in docker-compose.yml:

```yml
services:
...
api:
...
ports:
- "7052:8000"
# - "5678:5678" # Debugger port
```

3. Start the docker container `docker compose up -d api`
4. Connect to the debugger on port **5678**.

You can configure your IDE to do this with the build in debugger.

Expand Down

0 comments on commit 4d7ba07

Please sign in to comment.