Skip to content

Commit 21c6372

Browse files
committed
docs: Update wiki.md for .env setup and remove .env.sample
1 parent a361c2d commit 21c6372

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

.env.sample

Lines changed: 0 additions & 1 deletion
This file was deleted.

wiki.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,16 +151,16 @@ then start building a software by ``python3 run.py`` and go to [Visualizer Websi
151151
152152
To run your ChatDev application with Docker Compose, simply:
153153
154-
1. Find the `.env.sample` file in the root directory of your ChatDev project.
155-
2. Copy this file and rename it to `.env`.
156-
3. Open the `.env` file with the text editor of your choice.
157-
4. Replace `<Your OpenAI API Key>` with your actual OpenAI API key from OpenAI. Add other environment variables for local development as needed.
158-
5. Initiate the application by running:
159-
```commandline
154+
1. In the project root, create a `.env` with your text editor.
155+
2. Add `OPENAI_API_KEY=<Your OpenAI API Key>` and any other secrets.
156+
3. Save the file. It's ignored by Git for your security.
157+
4. Run the application with the specified command.
158+
160159
docker compose run --service-ports chatdev
161160
```
162161
This command will build the Docker image (if necessary) and start the container.
163162

163+
164164
Any changes you make to the project files on your host machine will sync in real-time inside the container, thanks to the configured bind mount in `docker-compose.yml`.
165165

166166
### Stopping the Application

0 commit comments

Comments
 (0)