Преглед изворни кода

Adjust docs a bit (#2135)

* tweak docs a bit

* move warning
Robert Brennan пре 1 година
родитељ
комит
89ac732cb6
2 измењених фајлова са 8 додато и 13 уклоњено
  1. 6 8
      README.md
  2. 2 5
      docs/modules/usage/intro.mdx

+ 6 - 8
README.md

@@ -51,22 +51,20 @@ You must be using Linux, Mac OS, or WSL on Windows.
 
 To start the app, run these commands, replacing `$(pwd)/workspace` with the directory you want OpenDevin to work with.
 
+> [!WARNING]
+> OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine.
+> But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.
+
 ```bash
 # The directory you want OpenDevin to work with. MUST be an absolute path!
 export WORKSPACE_BASE=$(pwd)/workspace;
-export SSH_PASSWORD="set some long password here";
 ```
 
-> [!WARNING]
-> OpenDevin runs bash commands within a Docker sandbox, so it should not affect your machine.
-> But your workspace directory will be attached to that sandbox, and files in the directory may be modified or deleted.
-
 ```bash
-docker run \
-    -it \
+docker run -it \
     --pull=always \
     -e SANDBOX_USER_ID=$(id -u) \
-    -e SSH_PASSWORD=$SSH_PASSWORD \
+    -e SSH_PASSWORD="make something up here" \
     -e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
     -v $WORKSPACE_BASE:/opt/workspace_base \
     -v /var/run/docker.sock:/var/run/docker.sock \

+ 2 - 5
docs/modules/usage/intro.mdx

@@ -66,7 +66,6 @@ To start the app, run these commands, replacing `$(pwd)/workspace` with the dire
 ```
 # The directory you want OpenDevin to work with. It MUST be an absolute path!
 export WORKSPACE_BASE=$(pwd)/workspace
-export SSH_PASSWORD="set some long password here";
 ```
 
 :::warning
@@ -74,12 +73,10 @@ OpenDevin runs bash commands within a Docker sandbox, so it should not affect yo
 :::
 
 ```
-docker run \
-    -it \
+docker run -it \
     --pull=always \
-    -e LLM_API_KEY \
     -e SANDBOX_USER_ID=$(id -u) \
-    -e SSH_PASSWORD=$SSH_PASSWORD \
+    -e SSH_PASSWORD="make something up here" \
     -e WORKSPACE_MOUNT_PATH=$WORKSPACE_BASE \
     -v $WORKSPACE_BASE:/opt/workspace_base \
     -v /var/run/docker.sock:/var/run/docker.sock \