From 7472c9224add1216f901d663bf2af214da7cf9f2 Mon Sep 17 00:00:00 2001 From: Marc Klingen Date: Mon, 9 Dec 2024 11:43:14 +0100 Subject: [PATCH] push --- pages/self-hosting/authentication-and-sso.mdx | 2 ++ .../automated-access-provisioning.mdx | 2 ++ pages/self-hosting/background-migrations.mdx | 3 ++- pages/self-hosting/configuration.mdx | 2 ++ pages/self-hosting/custom-base-path.mdx | 2 ++ pages/self-hosting/deployment-strategies.mdx | 2 ++ pages/self-hosting/docker-compose.mdx | 1 + pages/self-hosting/docker.mdx | 2 ++ pages/self-hosting/encryption.mdx | 2 ++ pages/self-hosting/headless-initialization.mdx | 2 ++ pages/self-hosting/index.mdx | 1 + pages/self-hosting/infrastructure/blobstorage.mdx | 3 ++- pages/self-hosting/infrastructure/cache.mdx | 3 ++- pages/self-hosting/infrastructure/clickhouse.mdx | 3 ++- pages/self-hosting/infrastructure/containers.mdx | 2 ++ pages/self-hosting/infrastructure/llm-api.mdx | 10 ++++++++++ pages/self-hosting/infrastructure/postgres.mdx | 15 ++++++++++++++- pages/self-hosting/kubernetes-helm.mdx | 1 + pages/self-hosting/license-key.mdx | 2 ++ pages/self-hosting/local.mdx | 1 + pages/self-hosting/networking.mdx | 2 ++ pages/self-hosting/organization-creators.mdx | 2 ++ pages/self-hosting/railway.mdx | 2 ++ pages/self-hosting/transactional-emails.mdx | 2 ++ pages/self-hosting/troubleshooting.mdx | 1 + pages/self-hosting/ui-customization.mdx | 2 ++ .../upgrade-guides/upgrade-v1-to-v2.mdx | 1 + .../upgrade-guides/upgrade-v2-to-v3.mdx | 1 + pages/self-hosting/upgrade.mdx | 3 ++- pages/self-hosting/v2/deployment-guide.mdx | 1 + pages/self-hosting/v2/docker-compose.mdx | 1 + pages/self-hosting/v2/index.mdx | 6 ++++++ 32 files changed, 79 insertions(+), 6 deletions(-) diff --git a/pages/self-hosting/authentication-and-sso.mdx b/pages/self-hosting/authentication-and-sso.mdx index 2e194f809..39d053a81 100644 --- a/pages/self-hosting/authentication-and-sso.mdx +++ b/pages/self-hosting/authentication-and-sso.mdx @@ -1,4 +1,6 @@ --- +title: Authentication and SSO (self-hosted) +description: Langfuse supports both email/password and SSO authentication. Follow this guide to configure authentication for your self-hosted Langfuse deployment. label: "Version: v3" --- diff --git a/pages/self-hosting/automated-access-provisioning.mdx b/pages/self-hosting/automated-access-provisioning.mdx index a0d9ef395..1464a6523 100644 --- a/pages/self-hosting/automated-access-provisioning.mdx +++ b/pages/self-hosting/automated-access-provisioning.mdx @@ -1,4 +1,6 @@ --- +title: Automated Access Provisioning (self-hosted) +description: Optionally, you can configure automated access provisioning for new users when self-hosting Langfuse. label: "Version: v3" --- diff --git a/pages/self-hosting/background-migrations.mdx b/pages/self-hosting/background-migrations.mdx index 709463d60..494f38809 100644 --- a/pages/self-hosting/background-migrations.mdx +++ b/pages/self-hosting/background-migrations.mdx @@ -1,5 +1,6 @@ --- -description: A guide on Langfuse Background Migrations. +title: Background Migrations (self-hosted) +description: Langfuse uses background migrations to perform long-running changes within the storage components when upgrading the application. label: "Version: v3" --- diff --git a/pages/self-hosting/configuration.mdx b/pages/self-hosting/configuration.mdx index d62d9c939..0b2bfa3be 100644 --- a/pages/self-hosting/configuration.mdx +++ b/pages/self-hosting/configuration.mdx @@ -1,4 +1,6 @@ --- +title: Configuration (self-hosted) +description: Langfuse has extensive configuration options via environment variables. label: "Version: v3" --- diff --git a/pages/self-hosting/custom-base-path.mdx b/pages/self-hosting/custom-base-path.mdx index 8cb2875f4..e605ed8d4 100644 --- a/pages/self-hosting/custom-base-path.mdx +++ b/pages/self-hosting/custom-base-path.mdx @@ -1,4 +1,6 @@ --- +title: Custom Base Path (self-hosted) +description: Follow this guide to deploy Langfuse on a custom base path, e.g. https://yourdomain.com/langfuse. label: "Version: v3" --- diff --git a/pages/self-hosting/deployment-strategies.mdx b/pages/self-hosting/deployment-strategies.mdx index 7c9a427e0..9fdc8de47 100644 --- a/pages/self-hosting/deployment-strategies.mdx +++ b/pages/self-hosting/deployment-strategies.mdx @@ -1,4 +1,6 @@ --- +title: Deployment Strategies (self-hosted) +description: Learn how to manage Langfuse effectively. It covers strategies for handling multiple projects and environments. label: "Version: v3" --- diff --git a/pages/self-hosting/docker-compose.mdx b/pages/self-hosting/docker-compose.mdx index f5e9a9527..02e3498e7 100644 --- a/pages/self-hosting/docker-compose.mdx +++ b/pages/self-hosting/docker-compose.mdx @@ -1,4 +1,5 @@ --- +title: Docker Compose (self-hosted) description: Step-by-step guide to run Langfuse on a VM using docker compose. label: "Version: v3" --- diff --git a/pages/self-hosting/docker.mdx b/pages/self-hosting/docker.mdx index 21ed06766..b577139a4 100644 --- a/pages/self-hosting/docker.mdx +++ b/pages/self-hosting/docker.mdx @@ -1,4 +1,6 @@ --- +title: Docker (self-hosted) +description: Learn how to deploy Langfuse v3 on your own infrastructure using Docker. label: "Version: v3" --- diff --git a/pages/self-hosting/encryption.mdx b/pages/self-hosting/encryption.mdx index 6ef2aa083..3dba1e87b 100644 --- a/pages/self-hosting/encryption.mdx +++ b/pages/self-hosting/encryption.mdx @@ -1,4 +1,6 @@ --- +title: Encryption (self-hosted) +description: Learn how to encrypt your self-hosted Langfuse deployment. This guide covers encryption in transit (HTTPS), at rest (database) and application-level encryption. label: "Version: v3" --- diff --git a/pages/self-hosting/headless-initialization.mdx b/pages/self-hosting/headless-initialization.mdx index 85ab3874b..60a6df392 100644 --- a/pages/self-hosting/headless-initialization.mdx +++ b/pages/self-hosting/headless-initialization.mdx @@ -1,4 +1,6 @@ --- +title: Headless Initialization (self-hosted) +description: Learn how to automatically initialize Langfuse resources via environment variables. label: "Version: v3" --- diff --git a/pages/self-hosting/index.mdx b/pages/self-hosting/index.mdx index d5a13871a..bdcfb2dcc 100644 --- a/pages/self-hosting/index.mdx +++ b/pages/self-hosting/index.mdx @@ -1,4 +1,5 @@ --- +title: Self-host Langfuse (Open Source LLM Observability) description: Step-by-step guide to run Langfuse on your local machine using docker compose. label: "Version: v3" --- diff --git a/pages/self-hosting/infrastructure/blobstorage.mdx b/pages/self-hosting/infrastructure/blobstorage.mdx index a8d12d944..4f85ead00 100644 --- a/pages/self-hosting/infrastructure/blobstorage.mdx +++ b/pages/self-hosting/infrastructure/blobstorage.mdx @@ -1,5 +1,6 @@ --- -description: How Langfuse uses S3 / Blob Storage +title: S3 / Blob Storage (self-hosted) +description: Langfuse uses S3 / Blob Storage to store raw events, multi-modal inputs, batch exports, and other files. label: "Version: v3" --- diff --git a/pages/self-hosting/infrastructure/cache.mdx b/pages/self-hosting/infrastructure/cache.mdx index 35939d93d..9d73e6daa 100644 --- a/pages/self-hosting/infrastructure/cache.mdx +++ b/pages/self-hosting/infrastructure/cache.mdx @@ -1,5 +1,6 @@ --- -description: How Langfuse uses Redis or Valkey +title: Cache (Redis/Valkey) (self-hosted) +description: Langfuse uses Redis/Valkey as a caching layer and queue. label: "Version: v3" --- diff --git a/pages/self-hosting/infrastructure/clickhouse.mdx b/pages/self-hosting/infrastructure/clickhouse.mdx index 2b1c1a35f..54352f2c1 100644 --- a/pages/self-hosting/infrastructure/clickhouse.mdx +++ b/pages/self-hosting/infrastructure/clickhouse.mdx @@ -1,5 +1,6 @@ --- -description: How Langfuse uses ClickHouse +title: ClickHouse (self-hosted) +description: Langfuse uses ClickHouse as the main OLAP storage solution for traces, observations, and scores. label: "Version: v3" --- diff --git a/pages/self-hosting/infrastructure/containers.mdx b/pages/self-hosting/infrastructure/containers.mdx index 832189c02..9aa8b470f 100644 --- a/pages/self-hosting/infrastructure/containers.mdx +++ b/pages/self-hosting/infrastructure/containers.mdx @@ -1,4 +1,6 @@ --- +title: Application Containers (self-hosted) +description: Langfuse uses Docker to containerize the application. The application is split into two containers (Langfuse Web and Langfuse Worker). label: "Version: v3" --- diff --git a/pages/self-hosting/infrastructure/llm-api.mdx b/pages/self-hosting/infrastructure/llm-api.mdx index 712fd4df8..bf39f0432 100644 --- a/pages/self-hosting/infrastructure/llm-api.mdx +++ b/pages/self-hosting/infrastructure/llm-api.mdx @@ -1,4 +1,6 @@ --- +title: LLM API / Gateway (self-hosted) +description: Optionally, you can configure Langfuse to use an external LLM API or gateway for add-on features. Langfuse tracing does not need access to the LLM API as traces are captured client-side. label: "Version: v3" --- @@ -6,6 +8,8 @@ label: "Version: v3" Optionally, you can configure Langfuse to use an external LLM API or gateway for add-on features. Langfuse tracing does not need access to the LLM API as traces are captured client-side. +## Supported LLM APIs + Langfuse supports: - OpenAI @@ -15,3 +19,9 @@ Langfuse supports: - Amazon Bedrock Via the OpenAI API, many other LLM services and proxies can be used. + +## Features powered by LLM API + +- [Playground](/docs/playground) +- [LLM-as-a-Judge Evaluation](/docs/scores/model-based-evals) +- [Prompt Experiments](/docs/datasets/prompt-experiments) diff --git a/pages/self-hosting/infrastructure/postgres.mdx b/pages/self-hosting/infrastructure/postgres.mdx index 21501e5d2..c892b9d6d 100644 --- a/pages/self-hosting/infrastructure/postgres.mdx +++ b/pages/self-hosting/infrastructure/postgres.mdx @@ -1,4 +1,6 @@ --- +title: Postgres Database (self-hosted) +description: Langfuse requires a persistent Postgres database to store its state. label: "Version: v3" --- @@ -6,7 +8,7 @@ label: "Version: v3" -This is a deep dive into the configuration of the Postgres database. Follow one of the [deployment guides](/self-hosting#deployment-options) to get started. +Follow one of the [deployment guides](/self-hosting#deployment-options) to get started. @@ -14,3 +16,14 @@ Langfuse requires a persistent Postgres database to store its state. You can use a managed service on AWS, Azure, or GCP, or host it yourself. Langfuse supports Postgres versions >= 12. + +## Use Cases + +Postgres is used for all transactional data, including: + +- Users +- Organizations +- Projects +- Datasets +- Encrypted API keys +- Settings diff --git a/pages/self-hosting/kubernetes-helm.mdx b/pages/self-hosting/kubernetes-helm.mdx index 860c4c70f..68523d199 100644 --- a/pages/self-hosting/kubernetes-helm.mdx +++ b/pages/self-hosting/kubernetes-helm.mdx @@ -1,4 +1,5 @@ --- +title: Kubernetes (Helm) (self-hosted) description: Step-by-step guide to run Langfuse on Kubernetes via Helm. label: "Version: v3" --- diff --git a/pages/self-hosting/license-key.mdx b/pages/self-hosting/license-key.mdx index a2b1f0d43..b34280cdc 100644 --- a/pages/self-hosting/license-key.mdx +++ b/pages/self-hosting/license-key.mdx @@ -1,4 +1,6 @@ --- +title: License Key (self-hosted) +description: Learn how to activate a license key for your self-hosted Langfuse deployment. label: "Version: v3" --- diff --git a/pages/self-hosting/local.mdx b/pages/self-hosting/local.mdx index f5bc4428e..4dd2eca06 100644 --- a/pages/self-hosting/local.mdx +++ b/pages/self-hosting/local.mdx @@ -1,4 +1,5 @@ --- +title: Run Langfuse Locally (self-hosted) description: Step-by-step guide to run Langfuse locally via docker compose. label: "Version: v3" --- diff --git a/pages/self-hosting/networking.mdx b/pages/self-hosting/networking.mdx index 2ba20fdbd..b9c017092 100644 --- a/pages/self-hosting/networking.mdx +++ b/pages/self-hosting/networking.mdx @@ -1,4 +1,6 @@ --- +title: Networking (self-hosted) +description: Learn how to configure networking for your self-hosted Langfuse deployment. Langfuse can be run without internet access. label: "Version: v3" --- diff --git a/pages/self-hosting/organization-creators.mdx b/pages/self-hosting/organization-creators.mdx index 598f17060..a598a99f1 100644 --- a/pages/self-hosting/organization-creators.mdx +++ b/pages/self-hosting/organization-creators.mdx @@ -1,4 +1,6 @@ --- +title: Allowlist of organization creators (self-hosted) +description: Learn how to restrict organization creation to a specific set of users in your self-hosted Langfuse deployment. label: "Version: v3" --- diff --git a/pages/self-hosting/railway.mdx b/pages/self-hosting/railway.mdx index 213eada7b..0e4318f23 100644 --- a/pages/self-hosting/railway.mdx +++ b/pages/self-hosting/railway.mdx @@ -1,4 +1,6 @@ --- +title: Deploy Langfuse v3 on Railway +description: Use this guide to deploy Langfuse v3 on Railway via the prebuilt template. label: "Version: v3" --- diff --git a/pages/self-hosting/transactional-emails.mdx b/pages/self-hosting/transactional-emails.mdx index fa520b3fe..8e7b1918a 100644 --- a/pages/self-hosting/transactional-emails.mdx +++ b/pages/self-hosting/transactional-emails.mdx @@ -1,4 +1,6 @@ --- +title: Transactional Emails (self-hosted) +description: Learn how to configure transactional emails for your self-hosted Langfuse deployment. label: "Version: v3" --- diff --git a/pages/self-hosting/troubleshooting.mdx b/pages/self-hosting/troubleshooting.mdx index 66177278c..a4203e148 100644 --- a/pages/self-hosting/troubleshooting.mdx +++ b/pages/self-hosting/troubleshooting.mdx @@ -1,4 +1,5 @@ --- +title: Troubleshooting a self-hosted Langfuse deployment description: Learn how to troubleshoot common issues with self-hosted Langfuse. label: "Version: v3" --- diff --git a/pages/self-hosting/ui-customization.mdx b/pages/self-hosting/ui-customization.mdx index 18d6abc48..24cbf41e3 100644 --- a/pages/self-hosting/ui-customization.mdx +++ b/pages/self-hosting/ui-customization.mdx @@ -1,4 +1,6 @@ --- +title: UI Customization (self-hosted) +description: Learn how to customize the Langfuse UI for your organization. label: "Version: v3" --- diff --git a/pages/self-hosting/upgrade-guides/upgrade-v1-to-v2.mdx b/pages/self-hosting/upgrade-guides/upgrade-v1-to-v2.mdx index 4332b0b2b..3f337da2c 100644 --- a/pages/self-hosting/upgrade-guides/upgrade-v1-to-v2.mdx +++ b/pages/self-hosting/upgrade-guides/upgrade-v1-to-v2.mdx @@ -1,4 +1,5 @@ --- +title: Migrate Langfuse v1 to v2 (self-hosted) description: A guide to upgrade a Langfuse v1 setup to v2. --- diff --git a/pages/self-hosting/upgrade-guides/upgrade-v2-to-v3.mdx b/pages/self-hosting/upgrade-guides/upgrade-v2-to-v3.mdx index 6c88ec44a..acfa7581f 100644 --- a/pages/self-hosting/upgrade-guides/upgrade-v2-to-v3.mdx +++ b/pages/self-hosting/upgrade-guides/upgrade-v2-to-v3.mdx @@ -1,4 +1,5 @@ --- +title: Migrate Langfuse v2 to v3 (self-hosted) description: A guide to upgrade a Langfuse v2 setup to v3. --- diff --git a/pages/self-hosting/upgrade.mdx b/pages/self-hosting/upgrade.mdx index 96dcc2890..a1a6d95a0 100644 --- a/pages/self-hosting/upgrade.mdx +++ b/pages/self-hosting/upgrade.mdx @@ -1,5 +1,6 @@ --- -description: A guide on upgrading Langfuse +title: How to upgrade a self-hosted Langfuse deployment +description: Use this guide to keep your Langfuse deployment up to date. Updates between minor/patch versions can be applied automatically. For major versions, please refer to the migration guides. label: "Version: v3" --- diff --git a/pages/self-hosting/v2/deployment-guide.mdx b/pages/self-hosting/v2/deployment-guide.mdx index 097211b13..84059ed45 100644 --- a/pages/self-hosting/v2/deployment-guide.mdx +++ b/pages/self-hosting/v2/deployment-guide.mdx @@ -1,4 +1,5 @@ --- +title: Self-hosting Langfuse v2 description: Self-host Langfuse in your infrastructure using Docker. label: "Version: v2" --- diff --git a/pages/self-hosting/v2/docker-compose.mdx b/pages/self-hosting/v2/docker-compose.mdx index aba038491..ee2bdb690 100644 --- a/pages/self-hosting/v2/docker-compose.mdx +++ b/pages/self-hosting/v2/docker-compose.mdx @@ -1,4 +1,5 @@ --- +title: Local Deployment (v2, docker compose) description: Step-by-step guide to run Langfuse on your local machine using docker compose. label: "Version: v2" --- diff --git a/pages/self-hosting/v2/index.mdx b/pages/self-hosting/v2/index.mdx index dc53db022..f01892da7 100644 --- a/pages/self-hosting/v2/index.mdx +++ b/pages/self-hosting/v2/index.mdx @@ -1,3 +1,9 @@ +--- +title: Self-host Langfuse v2 +description: Langfuse is open source and can be self-hosted using Docker. This section contains guides for different deployment scenarios. +label: "Version: v2" +--- + # Self-host Langfuse v2