Skip to content

Commit

Permalink
Update README.md docker doc to reflect switch to postgres (langchain-…
Browse files Browse the repository at this point in the history
…ai#250)

* Update README.md docker doc to reflect switch to postgres

* Revert removal of `start-interval`
  • Loading branch information
P. Taylor Goetz authored Mar 23, 2024
1 parent 38f707c commit 61d3e9c
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,31 +38,37 @@ This project supports a Docker-based setup, streamlining installation and execut

### Quick Start

0. **Prerequisites:**
1. **Prerequisites:**
Ensure you have Docker and docker-compose installed on your system.


1. **Clone the Repository:**
2. **Clone the Repository:**
Obtain the project files by cloning the repository.

```
git clone https://github.com/langchain-ai/opengpts.git
cd opengpts
```

2. **Set Up Environment Variables:**
3. **Set Up Environment Variables:**
Create a `.env` file in the root directory of the project by copying `.env.example` as a template, and add the following environment variables:
```shell
# At least one language model API key is required
OPENAI_API_KEY=sk-...
# LANGCHAIN_TRACING_V2=true
# LANGCHAIN_API_KEY=...

# Setup for Postgres. Docker compose will use these values to set up the database.
POSTGRES_PORT=5432
POSTGRES_DB=opengpts
POSTGRES_USER=postgres
POSTGRES_PASSWORD=...
```

Replace `sk-...` with your OpenAI API key and `...` with your LangChain API key.


3. **Run with Docker Compose:**
4. **Run with Docker Compose:**
In the root directory of the project, execute:

```
Expand All @@ -71,11 +77,11 @@ This project supports a Docker-based setup, streamlining installation and execut

This command builds the Docker images for the frontend and backend from their respective Dockerfiles and starts all necessary services, including Postgres.

4. **Access the Application:**
5. **Access the Application:**
With the services running, access the frontend at [http://localhost:5173](http://localhost:5173), substituting `5173` with the designated port number.


5. **Rebuilding After Changes:**
6. **Rebuilding After Changes:**
If you make changes to either the frontend or backend, rebuild the Docker images to reflect these changes. Run:
```
docker compose up --build
Expand Down

0 comments on commit 61d3e9c

Please sign in to comment.