Skip to content

Same agent Smaller bill. The tools and infrastructure to get more work from your AI. Fewer tokens. Less compute. Lower cost.

fix: Readme updates (#102)

Patcher998d227a44ec94
diff --git a/README.md b/README.md
index fe945f21..6cf9129c 100644
--- a/README.md
+++ b/README.md
@@ -253,7 +253,7 @@ Refer to the `dokumetry` [NodeJS SDK repository](https://github.com/dokulabs/dok
### Visualize and Analyze
-Once you have Doku Ingester and `DokuMetry` SDKs set up, you can instantly get insights into how your LLM applications. Just head over to Doku UI at `127.0.0.1:3000` on your browser to start exploring.
+Once you have Doku Ingester and `DokuMetry` SDKs set up, you can instantly get insights into how your LLM applications in the Doku Client UI. Just head over to `127.0.0.1:3000` on your browser to start exploring.
![Doku Client UI](https://github.com/dokulabs/.github/blob/main/profile/assets/doku-client-1.jpg?raw=true)
diff --git a/src/client/README.md b/src/client/README.md
index ae4239c0..b7026c7b 100644
--- a/src/client/README.md
+++ b/src/client/README.md
@@ -1,4 +1,4 @@
-## Run Doku UI Client server
+# Doku Client
[![Doku](https://img.shields.io/badge/Doku-orange)](https://github.com/dokulabs/doku)
[![License](https://img.shields.io/github/license/dokulabs/doku?label=license&logo=github&color=f80&logoColor=fff%22%20alt=%22License)](https://github.com/dokulabs/doku/blob/main/LICENSE)
@@ -15,10 +15,9 @@ Doku Client serves as the frontend UI for displaying visualizations and observab
## Features
-- **Rich Analytics Dashboard**: Visualize LLM performance, usage patterns, and cost metrics in real-time.
-- **User Management**: Integrated user management for access control and authentication.
-- **Flexible Data Source Integration**: Built-in support for ClickHouse, enabling efficient data retrieval and management.
-- **Responsive Design**: A UI that adapts to various screen sizes, providing an optimal viewing experience across devices.
+- **Comprehensive Analytics Dashboard**: Easily monitor Large Language Model performance, user activity, and critical metrics related to costs and tokens in real-time.
+- **User Management System**: Offers built-in user management to ensure secure access control and smooth authentication processes.
+- **Versatile Data Source Connectivity**: Seamlessly adjust and integrate your ClickHouse database details directly within the UI. This flexibility enables quick switches between databases to keep your Doku Client running efficiently.
## πŸš€ Quick Start
@@ -42,7 +41,7 @@ Follow the steps below to get Doku Client running in your environment. Both Dock
-e INIT_DB_USERNAME="<ClickHouse-username>" \
-e INIT_DB_PASSWORD="<ClickHouse-password>" \
-e SQLITE_DATABASE_URL=file:/app/client/data/data.db \
- --name doku_client doku-client
+ --name doku-client ghcr.io/dokulabs/doku-client:latest
```
3. Login to Doku UI at `127.0.0.1:3000` using the default credentials and start monitoring and evaluating your LLM Applications
@@ -96,16 +95,9 @@ You can also use the [Doku Helm Chart](https://github.com/dokulabs/helm/tree/mai
```sh
npm run dev
```
-
-<<<<<<< HEAD
8. Login to Doku UI at `127.0.0.1:3000` using the default credentials and start monitoring and evaluating your LLM Applications
- Email as `[email protected]`
- Password as `dokulabsuser`
-=======
-Enjoy Doku!πŸŽ‰
-
-### Found a bug or want to request a feature
->>>>>>> main
## Configuration
@@ -119,7 +111,7 @@ To configure Doku Client, you can pass the following environment values, each ta
| `INIT_DB_DATABASE` | Database name in ClickHouse for Doku Client. | | `default` |
| `INIT_DB_USERNAME` | Username for authenticating with ClickHouse. | | `default` |
| `INIT_DB_PASSWORD` | Password for authenticating with ClickHouse. | | `default` |
-| `SQLITE_DATABASE_URL`| Location of the SQLITE database for Doku Client data storage. | βœ“ | `file:/app/client/data/data.db` |
+| `SQLITE_DATABASE_URL`| Location of the SQLITE database for Doku Client data storage. | βœ“ | `file:/app/client/data/data.db` |
For more detailed information on configuration options and additional settings, please visit the Doku documentation page: [Doku Configuration Details](https://docs.dokulabs.com/latest/configuration).
@@ -137,4 +129,4 @@ Doku Client is available under the [Apache-2.0 license](https://github.com/dokul
## Support
-For support, issues, or feature requests, please submit an issue through the [GitHub issues](https://github.com/dokulabs/doku/issues) page for this repository.
\ No newline at end of file
+For support, issues, or feature requests, please submit an issue through the [GitHub issues](https://github.com/dokulabs/doku/issues) page for this repository.
diff --git a/src/ingester/README.md b/src/ingester/README.md
index d08c1da1..e8e14f0a 100644
--- a/src/ingester/README.md
+++ b/src/ingester/README.md
@@ -39,7 +39,7 @@ Follow the steps below to get Doku Ingester running in your environment. Both Do
-e DOKU_DB_NAME="<ClickHouse-Database-name>" \
-e DOKU_DB_USER="<ClickHouse-username>" \
-e DOKU_DB_PASSWORD="<ClickHouse-password>" \
- --name doku_ingester doku-ingester
+ --name doku-ingester ghcr.io/dokulabs/doku-ingester:latest
```
@@ -77,32 +77,32 @@ You can also use the [Doku Helm Chart](https://github.com/dokulabs/helm/tree/mai
To configure Doku Ingester, you can pass the following environment values, each tailored to suit your infrastructure and operational preferences. This customization allows Doku Ingester to seamlessly integrate with your existing setup and respond to its demands effectively.
-| Variable | Description | Default Value | Required | Example |
-|-------------------------|---------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------|:--------:|----------------------------------------|
-| `DOKU_DB_HOST` | Host address of the ClickHouse server for Doku to connect to. | | βœ“ | `127.0.0.1` |
-| `DOKU_DB_PORT` | Port on which ClickHouse listens. | | βœ“ | `9000` |
-| `DOKU_DB_NAME` | Database name in ClickHouse to be used by Doku. | | βœ“ | `default` |
-| `DOKU_DB_USER` | Username for authenticating with ClickHouse. | | βœ“ | `default` |
-| `DOKU_DB_PASSWORD` | Password for authenticating with ClickHouse. | | βœ“ | `DOKU` |
-| `DOKU_PRICING_JSON_URL` | URL of the JSON file containing LLM Pricing data. | `https://raw.githubusercontent.com/dokulabs/ingester/main/assets/pricing.json` | | `<URL>` |
-| `DOKU_DB_MAX_IDLE_CONNS`| Maximum number of concurrent idle database connections. | `10` | | `10` |
-| `DOKU_DB_MAX_OPEN_CONNS`| Maximum number of concurrent open database connections. | `20` | | `20` |
-| `DOKU_DB_RETENTION_PERIOD` | TTL for data in ClickHouse. | `6 MONTH` | | `"6 MONTH"` |
+| Variable | Description | Required | Example |
+|----------------------------|-----------------------------------------------------------------|:--------:|----------------------------------------|
+| `DOKU_DB_HOST` | Host address of the ClickHouse server for Doku to connect to. | βœ“ | `127.0.0.1` |
+| `DOKU_DB_PORT` | Port on which ClickHouse listens. | βœ“ | `9000` |
+| `DOKU_DB_NAME` | Database name in ClickHouse to be used by Doku. | βœ“ | `default` |
+| `DOKU_DB_USER` | Username for authenticating with ClickHouse. | βœ“ | `default` |
+| `DOKU_DB_PASSWORD` | Password for authenticating with ClickHouse. | βœ“ | `DOKU` |
+| `DOKU_PRICING_JSON_URL` | URL of the JSON file containing LLM Pricing data. | | `URL` |
+| `DOKU_DB_MAX_IDLE_CONNS` | Maximum number of concurrent idle database connections. | | `10` |
+| `DOKU_DB_MAX_OPEN_CONNS` | Maximum number of concurrent open database connections. | | `20` |
+| `DOKU_DB_RETENTION_PERIOD` | TTL for data in ClickHouse. | | `6 MONTH` |
For more detailed information on configuration options and additional settings, please visit the Doku documentation page: [Doku Configuration Details](https://docs.dokulabs.com/latest/configuration).
## Security
-Doku Ingester uses key based authentication mechanism to ensure the security of your data. Be sure to keep your API keys confidential and manage permissions diligently. Refer to our [Security Policy](SECURITY)
+Doku Ingester uses key based authentication mechanism to ensure the security of your data. Be sure to keep your API keys confidential and manage permissions diligently. Refer to our [Security Policy](../../SECURITY.md)
## Contributing
-We welcome contributions to the Doku Ingester project. Please refer to [CONTRIBUTING](CONTRIBUTING) for detailed guidelines on how you can participate.
+We welcome contributions to the Doku Ingester project. Please refer to [CONTRIBUTING](../../CONTRIBUTING.md) for detailed guidelines on how you can participate.
## License
-Doku Ingester is available under the [Apache-2.0 license](LICENSE).
+Doku Ingester is available under the [Apache-2.0 license](../../LICENSE).
## Support
-For support, issues, or feature requests, submit an issue through the [GitHub issues](https://github.com/dokulabs/ingester/issues) associated with this repository.
\ No newline at end of file
+For support, issues, or feature requests, submit an issue through the [GitHub issues](https://github.com/dokulabs/doku/issues) associated with this repository.