Browse Source

Point docker errors to troubleshooting doc (#1453)

Graham Neubig 1 year ago
parent
commit
c821d0967c

+ 4 - 3
docs/modules/usage/troubleshooting/troubleshooting.md

@@ -24,7 +24,7 @@ If you're running on Windows and having trouble, check out our [guide for Window
 ### Symptoms
 
 ```
-Error creating controller. Please check Docker is running using docker ps
+Error creating controller. Please check Docker is running and visit `https://github.com/OpenDevin/OpenDevin/blob/main/docs/guides/Troubleshooting.md` for more debugging information.
 ```
 
 ```
@@ -37,8 +37,9 @@ OpenDevin uses a docker container to do its work safely, without potentially bre
 
 ### Workarounds
 
-- Run `docker ps` to ensure that docker is running
-- Make sure you don't need `sudo` to run docker [see here](https://www.baeldung.com/linux/docker-run-without-sudo)
+* Run `docker ps` to ensure that docker is running
+* Make sure you don't need `sudo` to run docker [see here](https://www.baeldung.com/linux/docker-run-without-sudo)
+* If you are on a mac, check the [permissions requirements](https://docs.docker.com/desktop/mac/permission-requirements/) and in particular consider enabling the "Allow the default Docker socket to be used" under "Settings > Advanced" in Docker Desktop.
 
 ## [Unable to connect to SSH box](https://github.com/OpenDevin/OpenDevin/issues/1156)
 

+ 1 - 1
opendevin/sandbox/docker/exec_box.py

@@ -57,7 +57,7 @@ class DockerExecBox(Sandbox):
             self.docker_client = docker.from_env()
         except Exception as ex:
             logger.exception(
-                'Please check Docker is running using `docker ps`.', exc_info=False)
+                'Error creating controller. Please check Docker is running and visit `https://github.com/OpenDevin/OpenDevin/blob/main/docs/guides/Troubleshooting.md` for more debugging information.', exc_info=False)
             raise ex
 
         self.instance_id = sid if sid is not None else str(uuid.uuid4())

+ 1 - 1
opendevin/sandbox/docker/ssh_box.py

@@ -67,7 +67,7 @@ class DockerSSHBox(Sandbox):
             self.docker_client = docker.from_env()
         except Exception as ex:
             logger.exception(
-                'Please check Docker is running using `docker ps`.', exc_info=False)
+                'Error creating controller. Please check Docker is running and visit `https://github.com/OpenDevin/OpenDevin/blob/main/docs/guides/Troubleshooting.md` for more debugging information.', exc_info=False)
             raise ex
 
         self.instance_id = sid if sid is not None else str(uuid.uuid4())

+ 1 - 1
opendevin/server/agent/agent.py

@@ -154,7 +154,7 @@ class AgentUnit:
         except Exception as e:
             logger.exception(f'Error creating controller: {e}')
             await self.send_error(
-                'Error creating controller. Please check Docker is running using `docker ps`.'
+                'Error creating controller. Please check Docker is running and visit `https://github.com/OpenDevin/OpenDevin/blob/main/docs/guides/Troubleshooting.md` for more debugging information..'
             )
             return
         await self.init_done()