push

langfuse · Dec 9, 2024 · 7472c92 · 7472c92
1 parent 9bec862
commit 7472c92
Show file tree

Hide file tree

Showing 32 changed files with 79 additions and 6 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,11 +1,15 @@
 ---
+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"
 ---
 
 # LLM API / Gateway
 
 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
@@ -1,16 +1,29 @@
 ---
+title: Postgres Database (self-hosted)
+description: Langfuse requires a persistent Postgres database to store its state.
 label: "Version: v3"
 ---
 
 # Postgres Database
 
 <Callout type="info">
 
-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.
 
 </Callout>
 
 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
 
 <Callout type="info">