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

Updated docs with SSL updates #829

Merged
merged 1 commit into from
Dec 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions apps/opik-documentation/documentation/dev_script.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
npm run docusaurus clean-api-docs all
npm run docusaurus gen-api-docs all

# Convert the files to markdown if that has not already been done
jupyter nbconvert docs/cookbook/*.ipynb --to markdown

# Start the docs server and rebuild the cookbooks on change
npx concurrently \
"docusaurus start" \
Expand Down
2 changes: 1 addition & 1 deletion apps/opik-documentation/documentation/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Changelog

# Weekly Changelog

## Week of 2024-12-02
## Week of 2024-12-02

**Opik Dashboard**:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,26 @@ You can find a full list of the the configuration options in the [Configuration

Here is a list of the configuration values that you can set:

| Configuration Name | Environment variable | Description |
| url_override | `OPIK_URL_OVERRIDE` | The URL of the Opik server to use - Defaults to `https://www.comet.com/opik/api` |
| api_key | `OPIK_API_KEY` | The API key to use - Only required if you are using the Opik Cloud version of the platform |
| workspace | `OPIK_WORKSPACE` | The workspace to use - Only required if you are using the Opik Cloud version of the platform |
| project_name | `OPIK_PROJECT_NAME` | The project name to use |
| default_flush_timeout | `OPIK_DEFAULT_FLUSH_TIMEOUT` | The default flush timeout to use - Defaults to no timeout |
| Configuration Name | Environment variable | Description |
| -------------------------- | ---------------------------- | -------------------------------------------------------------------------------------------- |
| url_override | `OPIK_URL_OVERRIDE` | The URL of the Opik server to use - Defaults to `https://www.comet.com/opik/api` |
| api_key | `OPIK_API_KEY` | The API key to use - Only required if you are using the Opik Cloud version of the platform |
| workspace | `OPIK_WORKSPACE` | The workspace to use - Only required if you are using the Opik Cloud version of the platform |
| project_name | `OPIK_PROJECT_NAME` | The project name to use |
| default_flush_timeout | `OPIK_DEFAULT_FLUSH_TIMEOUT` | The default flush timeout to use - Defaults to no timeout |
| opik_check_tls_certificate | `OPIK_CHECK_TLS_CERTIFICATE` | Flag to check the TLS certificate of the Opik server - Defaults to `true` |

### Common error messages

#### SSL certificate error

If you encounter the following error:

```
[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: self-signed certificate in certificate chain (_ssl.c:1006)
```

You can resolve it by either:

- Disable the TLS certificate check by setting the `OPIK_CHECK_TLS_CERTIFICATE` environment variable to `false`
- Add the Opik server's certificate to your trusted certificates by setting the `REQUESTS_CA_BUNDLE` environment variable