diff --git a/hosting/hosting_options/northflank.mdx b/hosting/hosting_options/northflank.mdx new file mode 100644 index 0000000..ae161ac --- /dev/null +++ b/hosting/hosting_options/northflank.mdx @@ -0,0 +1,79 @@ +--- +title: Langtrace on Northflank +sidebarTitle: Northflank +description: Running Langtrace Client on Northflank +--- + +## Requirements + +1. [Northflank](https://app.northflank.com/signup) account + +## Resources Created + +| Resource Type | Comments | +| ------------------ | ----------------------------------- | +| Clickhouse Service | To store traces. | +| Postgres Addon | For login and dataset related info. | +| Langtrace Client | Langtrace app with frontend. | + +## Setup + +Setting up Langtrace on Northflank is now effortless. Just follow these simple steps: + +### Step 1: Open the Northflank Template + +[![Deploy on Northflank](/images/northflank/deploy-northflank-button.svg)](https://northflank.com/stacks/deploy-langtrace) + +Clicking the button above will direct you to the Langtrace Northflank template deployment page. + +![Northflank template](/images/northflank/langtrace-template-home.png) + +### Step 2: Configure Authentication + +When deploying the template, you’ll need to set up authentication for your Langtrace instance: + +- Under the **Configuration** section, add the following environment variables: + - `ADMIN_EMAIL`: Your desired admin email + - `ADMIN_PASSWORD`: Your desired admin password +- For additional authentication methods (e.g. Google OAuth, Azure AD), refer to our [Authentication](/hosting/auth) guide to configure the necessary environment variables. + +![Northflank inputs](/images/northflank/langtrace-template-config.png) + +### Step 3: Deploy the Template + +- Click **Deploy Stack** to start the deployment. +- Northflank will automatically create and configure the required services — Clickhouse, PostgreSQL, and Langtrace Client. +- Deployment typically takes about 2 minutes. + +![Northflank Success](/images/northflank/langtrace-template-run.png) + +### Step 4: Access Langtrace + +- Once all services are running, open the **langtrace-client** service. +- Click the **Public URL** to access your Langtrace dashboard. + +![Northflank URL](/images/northflank/langtrace-template-url.png) + +Login using your previously configured admin credentials. +Then follow the [Quickstart Guide](/quickstart) to begin monitoring your LLM applications. + +## Cleanup + +To remove all resources: + +1. Go to your **Northflank project dashboard**. +2. Click on **Project Settings → Danger Zone → Delete Project**. +3. Confirm deletion to remove all services, addons, and configurations. + +## Troubleshooting + + + + This usually occurs when the Clickhouse service runs out of memory. + You can increase the memory limit of the Clickhouse service from the **Resources** tab under its configuration. + + + + If the public URL doesn’t open, ensure the **langtrace-client** service has an **HTTP port (3000)** exposed and marked as **Public** under **Networking settings**. + + diff --git a/hosting/overview.mdx b/hosting/overview.mdx index dd27f66..4a4a9ae 100644 --- a/hosting/overview.mdx +++ b/hosting/overview.mdx @@ -51,4 +51,7 @@ Langtrace supports multiple authentication methods, including Admin Password, Go Run Langtrace on Railway with a single click! + + Run Langtrace on Northflank with a single click! + diff --git a/images/northflank/deploy-northflank-button.svg b/images/northflank/deploy-northflank-button.svg new file mode 100644 index 0000000..4fcf68b --- /dev/null +++ b/images/northflank/deploy-northflank-button.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/images/northflank/langtrace-template-config.png b/images/northflank/langtrace-template-config.png new file mode 100644 index 0000000..3618541 Binary files /dev/null and b/images/northflank/langtrace-template-config.png differ diff --git a/images/northflank/langtrace-template-home.png b/images/northflank/langtrace-template-home.png new file mode 100644 index 0000000..db3b816 Binary files /dev/null and b/images/northflank/langtrace-template-home.png differ diff --git a/images/northflank/langtrace-template-run.png b/images/northflank/langtrace-template-run.png new file mode 100644 index 0000000..a603c7d Binary files /dev/null and b/images/northflank/langtrace-template-run.png differ diff --git a/images/northflank/langtrace-template-url.png b/images/northflank/langtrace-template-url.png new file mode 100644 index 0000000..41f5118 Binary files /dev/null and b/images/northflank/langtrace-template-url.png differ diff --git a/mint.json b/mint.json index 78a5f5d..7f63eda 100644 --- a/mint.json +++ b/mint.json @@ -227,7 +227,8 @@ "hosting/hosting_options/docker-compose", "hosting/hosting_options/kubernetes", "hosting/hosting_options/azure", - "hosting/hosting_options/railway" + "hosting/hosting_options/railway", + "hosting/hosting_options/northflank" ] } ]