Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(docs): modify readme file content run steps #36

Merged
merged 10 commits into from
Apr 21, 2024
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,16 +44,27 @@ Enterprise ready knowledge discovery solution that empowers users to
To get started with Nesis

### Deploy with Docker Compose
1. Obtain your **OPENAI_API_KEY** and update the compose.yml file entry.
1. Obtain your **OPENAI_API_KEY** from https://platform.openai.com/api-keys:
- and update the `compose.yml` file entry.

2. Start all services locally with the provided docker compose file.

```commandline
docker-compose -f compose.yml up
```

2. Then connect to your instance via http://localhost:58000 and login with `email/password` = `[email protected]/password`
3. Connect to your minio instance via http://localhost:59001/ and login with `username/password` = `your_username/your_password`
2. Then connect to your instance via http://localhost:58000 with the following login credentials:
- *email* = `[email protected]`
- *password* = `password`

3. Connect to your minio instance via http://localhost:59001/ with the following login credentials:
- *username* = `YOUR_USERNAME`
- *password* = `YOUR_PASSWORD`
- *Note*: Replace `YOUR_USERNAME` and `YOUR_PASSWORD` with the correct values of your `username` and `password`.


4. Upload some documents into your minio `documents` bucket.

5. Back on your Nesis page, register the minio datasource with
1. Navigate to **Settings** -> **Datasource** -> **Add**
2. Enter the details;
Expand All @@ -64,7 +75,7 @@ To get started with Nesis
6. Username: **your_username**
7. Password: **your_password**
8. Click **Create**
9. After about 5 minutes, the background process will start indexing documents and then you should be able to query your documents.
9. After about 5 minutes, the background process will start indexing your documents and then you should be able to converse with your documents.
namwanza marked this conversation as resolved.
Show resolved Hide resolved

### Deploy with Kubernetes
To deploy Nesis into your kubernetes cluster, run
Expand Down