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

Config Documentation for Pebblo #166

Merged
merged 10 commits into from
Feb 20, 2024
Next Next commit
Added configutationdocumentation for pebblo
KunalJadhav5 committed Feb 15, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 4da56682154309b77c41e91d3293be0a3bae6f56
42 changes: 42 additions & 0 deletions docs/gh_pages/docs/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Pebblo Configuration File

### Introduction

This configuration file specifies settings for various components of the Pebblo application.

### Configuration Details

#### Daemon

- `port`: Specifies the port number on which the Pebblo daemon listens for incoming connections.
- `host`: Specifies the host address on which the Pebblo daemon is running.
shreyas-damle marked this conversation as resolved.
Show resolved Hide resolved
KunalJadhav5 marked this conversation as resolved.
Show resolved Hide resolved

### Logging

- `level`: Sets the logging level for the Pebblo application. Possible values are 'info', 'debug', 'error', 'warning', and 'critical'.

### Reports

- `format`: Specifies the format of generated reports. Available options include 'pdf', 'html', etc.
KunalJadhav5 marked this conversation as resolved.
Show resolved Hide resolved
- `renderer`: Specifies the rendering engine for generating reports.
- `outputDir`: Defines the directory where generated reports will be saved.

### Configuration Example

```commandline
daemon:
port: 8000
host: localhost
logging:
level: info
reports:
format: pdf
renderer: weasyprint
outputDir: ~/.pebblo
KunalJadhav5 marked this conversation as resolved.
Show resolved Hide resolved

```

### Validation

- The Pebblo application validates the configuration file upon startup.
- If the configuration file contains errors or invalid values, Pebblo will log appropriate error messages and may use default values for parameters.
KunalJadhav5 marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 8 additions & 0 deletions docs/gh_pages/docs/installation.md
Original file line number Diff line number Diff line change
@@ -29,3 +29,11 @@ pebblo
Pebblo daemon now listens to `localhost:8000` to accept Gen-AI application data snippets for inspection and reporting.

see [troubeshooting](troubleshooting.md) if you face any issues.

#### Pebblo Optional Flags

- `--config <file>`: Specifies a custom configuration file in yaml format.

```bash
pebblo --config [PATH TO CONFIG FILE]
````
1 change: 1 addition & 0 deletions docs/gh_pages/docs/introduction.md
Original file line number Diff line number Diff line change
@@ -31,5 +31,6 @@ Pebblo has two components.
- [Development Environment](development.md)
- [Pebblo Daemon](daemon.md)
- [Pebblo Safe DataLoader for Langchain](rag.md)
- [Pebblo Configuration File ](config.md)
shreyas-damle marked this conversation as resolved.
Show resolved Hide resolved
- [Reports](reports.md)
- [Troubleshooting](troubleshooting.md)