Skip to content

Commit 56e8063

Browse files
committed
docs: add Windows-specific troubleshooting for Docker commands
- Add winpty prefix note for createsuperuser command on Windows - Add Windows-Specific Issues troubleshooting section - Document fix for interactive commands hanging in Git Bash/MINGW - Document fix for 'No such container' errors
1 parent 3de3de5 commit 56e8063

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/setup.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,19 @@ While the containers are running, open a **separate terminal** and run:
3838
docker compose run --rm django python manage.py migrate
3939

4040
# Create an admin user (you will be prompted for email and password)
41-
docker compose run --rm django python manage.py createsuperuser
41+
docker compose run --rm -it django python manage.py createsuperuser
4242

4343
# Create OAuth client for authentication
4444
docker compose run --rm django python manage.py makeclient
4545
```
4646

4747
> **Note:** The `createsuperuser` command prompts you to create login credentials (email and password). Use these credentials to sign into both the Admin Panel and User Interface. If you forget your password, run `createsuperuser` again to create a new admin account.
4848
49+
> **Windows Users:** If the `createsuperuser` command hangs or doesn't show prompts, prefix the command with `winpty`:
50+
> ```bash
51+
> winpty docker compose run --rm -it django python manage.py createsuperuser
52+
> ```
53+
4954
### 4. Load Sample Data (Optional)
5055
5156
The ingest command loads datasets, charts, and project configuration from an ingestion file:
@@ -157,3 +162,23 @@ docker compose up
157162
```
158163

159164
GPU acceleration is optional and only needed for accelerated inferencing.
165+
166+
### Windows-Specific Issues
167+
168+
**Interactive commands don't work or hang:**
169+
170+
On Windows (especially Git Bash/MINGW), interactive Docker commands like `createsuperuser` may hang or fail to display prompts. Prefix the command with `winpty`:
171+
172+
```bash
173+
winpty docker compose run --rm -it django python manage.py createsuperuser
174+
```
175+
176+
**"No such container" errors:**
177+
178+
If you see errors like `No such container: django` when trying to attach to a running container, use `docker compose run` instead:
179+
180+
```bash
181+
docker compose run --rm -it django python manage.py <command>
182+
```
183+
184+
This creates a new container instance rather than attaching to an existing one.

0 commit comments

Comments
 (0)