Skip to content

Commit

Permalink
chore(wren-ui): update e2e README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fredalai committed Oct 28, 2024
1 parent b6ad308 commit 508d3b6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
5 changes: 3 additions & 2 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,9 @@ Path structure as following:

## How to start with OpenAI
1. copy `.env.example` to `.env.local` and modify the OpenAI API key.
2. start all services: `docker-compose --env-file .env.local up -d`.
3. stop all services: `docker-compose --env-file .env.local down`.
2. (optional) if your port 3000 is occupied, you can modify the `HOST_PORT` in `.env.local`.
3. start all services: `docker-compose --env-file .env.local up -d`.
4. stop all services: `docker-compose --env-file .env.local down`.

## How to start with custom LLM
1. copy `.env.example` to `.env.local` and modify the OpenAI API key.
Expand Down
24 changes: 23 additions & 1 deletion wren-ui/e2e/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## How to run e2e test locally

1. Make sure you have start all Wren AI services. ([How to start](https://github.com/Canner/WrenAI/blob/3234dc218b105caba04e1cdab7b1cb7140fc9b90/docker/README.md#how-to-start))
1. Make sure you have start all Wren AI services. ([How to start](https://github.com/Canner/WrenAI/blob/main/docker/README.md#how-to-start))

2. Create a `e2e.config.json` file under `wren-ui/e2e` folder and replace all data sources needed values in `./config.ts`.

Expand All @@ -25,6 +25,28 @@
database: 'postgresql-database',
ssl: false,
},
mysql: {
host: 'mysql-host',
port: '3306',
username: 'mysql-username',
password: 'mysql-password',
database: 'mysql-database',
},
sqlServer: {
host: 'sqlServer-host',
port: '1433',
username: 'sqlServer-username',
password: 'sqlServer-password',
database: 'sqlServer-database',
},
trino: {
host: 'trino-host',
port: '8081',
catalog: 'trino-catalog',
schema: 'trino-schema',
username: 'trino-username',
password: 'trino-password',
},
};
```

Expand Down

0 comments on commit 508d3b6

Please sign in to comment.