Troubleshooting¶
Start with devbox doctor — it checks most prerequisites automatically:
Common Issues¶
"failed to read config file" / config file not found¶
Cause: No devbox.yaml in the current directory.
Fix:
Or specify the project directory:
"'name' is required" / "'server' is required"¶
Cause: devbox.yaml is missing the name or server field.
Fix: Add the missing field to your devbox.yaml:
See Configuration Reference for all required fields.
Cannot connect to server via SSH¶
Cause: SSH is not configured for the server name, or the server is unreachable.
Fix:
-
Verify SSH access:
-
If it fails, add an entry to
~/.ssh/config: -
Check that Tailscale is running on both machines:
Docker not found on server¶
Cause: Docker is not installed or the daemon is not running on the server.
Fix:
-
Install Docker on the server:
-
Start the Docker daemon:
-
Add your user to the docker group (avoids needing
sudo):
Tailscale serve failed¶
Cause: Tailscale is not running, not logged in, or doesn't have permissions to serve ports.
Fix:
-
Check Tailscale status on the server:
-
If not connected, log in:
-
Verify that Tailscale Funnel/Serve is enabled in your Tailscale admin console under DNS settings.
Port already in use¶
Cause: Another container or process is using the same port on the server.
Fix:
-
Check what's using the port:
-
Either stop the conflicting process or change the port in
devbox.yaml:
Workspace already exists¶
Cause: A workspace with the same name already exists on the server.
What happens: devbox up automatically starts the existing workspace instead of creating a new one. This is expected behavior.
To start fresh:
Slow clone / large repository¶
Cause: The git repository is large and takes time to clone over SSH.
Fix:
- Use a shallow clone by keeping your repo lean
- Ensure the server has good network connectivity
- If the repo is already cloned,
devbox upwill reuse it (only the first run is slow)
Permission denied on server¶
Cause: Your user doesn't have permission to run Docker commands or access the workspace directory.
Fix:
-
Add your user to the docker group:
-
Log out and back in for the group change to take effect:
Getting Help¶
If your issue isn't listed here:
- Run
devbox doctor --server <name>and check all health checks pass - Run with verbose logging:
devbox -v up - Open an issue with the error output