OpenBMB/ChatDev
1
1
Fork 0
mirror of https://github.com/OpenBMB/ChatDev.git synced 2024-12-25 04:44:50 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: Update wiki.md for .env setup and remove .env.sample

Browse Source
This commit is contained in:
teamchong 2023-11-18 10:36:27 -05:00
parent a361c2d596
commit 21c637269e
2 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.env.sample
View File

@ -1 +0,0 @@
OPENAI_API_KEY=<Your Open API Key>

12
wiki.md
View File

@ -151,16 +151,16 @@ then start building a software by ``python3 run.py`` and go to [Visualizer Websi
To run your ChatDev application with Docker Compose, simply: To run your ChatDev application with Docker Compose, simply:
1. Find the `.env.sample` file in the root directory of your ChatDev project. 1. In the project root, create a `.env` with your text editor.
2. Copy this file and rename it to `.env`. 2. Add `OPENAI_API_KEY=<Your OpenAI API Key>` and any other secrets.
3. Open the `.env` file with the text editor of your choice. 3. Save the file. It's ignored by Git for your security.
4. Replace `<Your OpenAI API Key>` with your actual OpenAI API key from OpenAI. Add other environment variables for local development as needed. 4. Run the application with the specified command.
5. Initiate the application by running:
```commandline
docker compose run --service-ports chatdev docker compose run --service-ports chatdev
``` ```
This command will build the Docker image (if necessary) and start the container. This command will build the Docker image (if necessary) and start the container.
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`. 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`.
### Stopping the Application ### Stopping the Application