From d068b00516b770ba08ba88f34a28c3055ed9d6ba Mon Sep 17 00:00:00 2001 From: William Fu-Hinthorn <13333726+hinthornw@users.noreply.github.com> Date: Wed, 22 Jan 2025 15:53:07 -0800 Subject: [PATCH 1/2] Update license key troubleshooting --- docs/docs/concepts/deployment_options.md | 2 +- docs/docs/concepts/index.md | 2 +- docs/docs/concepts/self_hosted.md | 2 +- docs/docs/how-tos/index.md | 6 +++ .../troubleshooting/errors/INVALID_LICENSE.md | 48 +++++++++++++++++++ docs/docs/troubleshooting/errors/index.md | 8 +++- docs/docs/tutorials/deployment.md | 2 +- docs/mkdocs.yml | 1 + 8 files changed, 66 insertions(+), 5 deletions(-) create mode 100644 docs/docs/troubleshooting/errors/INVALID_LICENSE.md diff --git a/docs/docs/concepts/deployment_options.md b/docs/docs/concepts/deployment_options.md index e377f0f918..2b497b8359 100644 --- a/docs/docs/concepts/deployment_options.md +++ b/docs/docs/concepts/deployment_options.md @@ -51,7 +51,7 @@ For more information, please see: The LangGraph Platform Deployments view (within LangSmith SaaS and self-hosted LangSmith) is not available for Self-Hosted Lite LangGraph deployments. Self-hosted LangGraph deployments are managed externally from LangSmith (e.g. there is no UI to manage these deployments). -The Self-Hosted Lite deployment option is a free (up to 1 million nodes executed), limited version of LangGraph Platform that you can run locally or in a self-hosted manner. +The Self-Hosted Lite deployment option is a free (up to 1 million nodes executed per annum), limited version of LangGraph Platform that you can run locally or in a self-hosted manner. With a Self-Hosted Lite deployment, you are responsible for managing the infrastructure, including setting up and maintaining required databases and Redis instances. diff --git a/docs/docs/concepts/index.md b/docs/docs/concepts/index.md index 2d97f72b21..47deaa7e3d 100644 --- a/docs/docs/concepts/index.md +++ b/docs/docs/concepts/index.md @@ -71,7 +71,7 @@ The LangGraph Platform comprises several components that work together to suppor ### Deployment Options -- [Self-Hosted Lite](./self_hosted.md): A free (up to 1 million nodes executed), limited version of LangGraph Platform that you can run locally or in a self-hosted manner +- [Self-Hosted Lite](./self_hosted.md): A free (up to 1 million nodes executed per year), limited version of LangGraph Platform that you can run locally or in a self-hosted manner - [Cloud SaaS](./langgraph_cloud.md): Hosted as part of LangSmith. - [Bring Your Own Cloud](./bring_your_own_cloud.md): We manage the infrastructure, so you don't have to, but the infrastructure all runs within your cloud. - [Self-Hosted Enterprise](./self_hosted.md): Completely managed by you. \ No newline at end of file diff --git a/docs/docs/concepts/self_hosted.md b/docs/docs/concepts/self_hosted.md index 11311803eb..d69a13a964 100644 --- a/docs/docs/concepts/self_hosted.md +++ b/docs/docs/concepts/self_hosted.md @@ -11,7 +11,7 @@ There are two versions of the self-hosted deployment: [Self-Hosted Enterprise](. ### Self-Hosted Lite -The Self-Hosted Lite version is a limited version of LangGraph Platform that you can run locally or in a self-hosted manner (up to 1 million nodes executed). +The Self-Hosted Lite version is a limited version of LangGraph Platform that you can run locally or in a self-hosted manner (up to 1 million nodes executed per year). When using the Self-Hosted Lite version, you authenticate with a [LangSmith](https://smith.langchain.com/) API key. diff --git a/docs/docs/how-tos/index.md b/docs/docs/how-tos/index.md index 7e626905a9..6207dda2a1 100644 --- a/docs/docs/how-tos/index.md +++ b/docs/docs/how-tos/index.md @@ -276,3 +276,9 @@ These are the guides for resolving common errors you may find while building wit - [INVALID_GRAPH_NODE_RETURN_VALUE](../troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md) - [MULTIPLE_SUBGRAPHS](../troubleshooting/errors/MULTIPLE_SUBGRAPHS.md) - [INVALID_CHAT_HISTORY](../troubleshooting/errors/INVALID_CHAT_HISTORY.md) + +### LangGraph Platform Troubleshooting + +These guides provide troubleshooting information for errors that are specific to the LangGraph Platform. + +- [INVALID_LICENSE](../troubleshooting/errors/INVALID_LICENSE.md) \ No newline at end of file diff --git a/docs/docs/troubleshooting/errors/INVALID_LICENSE.md b/docs/docs/troubleshooting/errors/INVALID_LICENSE.md new file mode 100644 index 0000000000..de5a6244c3 --- /dev/null +++ b/docs/docs/troubleshooting/errors/INVALID_LICENSE.md @@ -0,0 +1,48 @@ +# INVALID_LICENSE + +This error is raised when license verification fails while attempting to start a self-hosted LangGraph Platform server. This error is specific to the LangGraph Platform and is not related to the open source libraries. + +## When This Occurs + +This error occurs when running a self-hosted deployment of LangGraph Platform without a valid enterprise license or API key. + +## Troubleshooting + +### Confirm deployment type + +First, confirm the desired mode of deployment. + +#### For Local Development + +If you're just developing locally, you can use the lightweight in-memory server by running `langgraph dev`. +See the [local server](../how-tos/local-server.md) docs for more information. + +#### For Managed LangGraph Platform + +If you would like a fast managed environment, consider the [Cloud SaaS](../langgraph_cloud.md) deployment option. This requires no additional license key. + +#### For Self-Hosted Lite (Limited Features) + +If your deployment is unlikely to see more than 1 million node executions per year and don't need Crons and other enterprise features, consider the [Self-Hosted Lite](../deployment_options.md#self-hosted-lite) deployment option. + +You can deploy with Self-Hosted Lite by setting a valid `LANGSMITH_API_KEY` in your environment (e.g., in the `.env` file referenced by `langgraph.json`) and building a Docker image. The API key must be associated with an account on a **Plus** plan or greater. + +#### For Self-Hosted Enterprise (Full Features) + +For full self-hosting, set the `LANGGRAPH_CLOUD_LICENSE_KEY` environment variable. If you are interested in an enterprise license key, please contact the LangChain support team. + +For more information on deployment options and their features, see the [Deployment Options](../../concepts/deployment_options.md) documentation. + +### Confirm credentials + +If you have confirmed that you would like to self-host LangGraph Platform, please verify your credentials. + +#### For Self-Hosted Lite + +1. Confirm that you have provided a working `LANGSMITH_API_KEY` environment variable in your deployment environment or `.env` file +2. Confirm the provided API key is associated with an account on a **Plus** or **Enterprise** plan (or equivalent) + +#### For Self-Hosted Enterprise + +1. Confirm that you have provided a working `LANGGRAPH_CLOUD_LICENSE_KEY` environment variable in your deployment environment or `.env` file +2. Confirm the key is still valid and has not surpassed its expiration date \ No newline at end of file diff --git a/docs/docs/troubleshooting/errors/index.md b/docs/docs/troubleshooting/errors/index.md index c8a21d5d54..1b2c5da43d 100644 --- a/docs/docs/troubleshooting/errors/index.md +++ b/docs/docs/troubleshooting/errors/index.md @@ -1,6 +1,6 @@ # Error reference -This page contains guides around resolving common errors you may find while building with LangChain. +This page contains guides around resolving common errors you may find while building with LangGraph. Errors referenced below will have an `lc_error_code` property corresponding to one of the below codes when they are thrown in code. - [GRAPH_RECURSION_LIMIT](./GRAPH_RECURSION_LIMIT.md) @@ -8,3 +8,9 @@ Errors referenced below will have an `lc_error_code` property corresponding to o - [INVALID_GRAPH_NODE_RETURN_VALUE](./INVALID_GRAPH_NODE_RETURN_VALUE.md) - [MULTIPLE_SUBGRAPHS](./MULTIPLE_SUBGRAPHS.md) - [INVALID_CHAT_HISTORY](./INVALID_CHAT_HISTORY.md) + +## LangGraph Platform + +These guides provide troubleshooting information for errors that are specific to the LangGraph Platform. + +- [INVALID_LICENSE](./INVALID_LICENSE.md) diff --git a/docs/docs/tutorials/deployment.md b/docs/docs/tutorials/deployment.md index 39fa93cba0..29470fe636 100644 --- a/docs/docs/tutorials/deployment.md +++ b/docs/docs/tutorials/deployment.md @@ -12,7 +12,7 @@ Get started deploying your LangGraph applications locally or on the cloud with ## Deployment Options -- [Self-Hosted Lite](../concepts/self_hosted.md): A free (up to 1 million nodes executed), limited version of LangGraph Platform that you can run locally or in a self-hosted manner +- [Self-Hosted Lite](../concepts/self_hosted.md): A free (up to 1 million nodes executed per year), limited version of LangGraph Platform that you can run locally or in a self-hosted manner - [Cloud SaaS](../concepts/langgraph_cloud.md): Hosted as part of LangSmith. - [Bring Your Own Cloud](../concepts/bring_your_own_cloud.md): We manage the infrastructure, so you don't have to, but the infrastructure all runs within your cloud. - [Self-Hosted Enterprise](../concepts/self_hosted.md): Completely managed by you. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 82fdf42494..19408bef24 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -358,6 +358,7 @@ nav: - troubleshooting/errors/INVALID_GRAPH_NODE_RETURN_VALUE.md - troubleshooting/errors/MULTIPLE_SUBGRAPHS.md - troubleshooting/errors/INVALID_CHAT_HISTORY.md + - troubleshooting/errors/INVALID_LICENSE.md - LangGraph Academy Course: https://academy.langchain.com/courses/intro-to-langgraph - API reference: From c2f1670f2bd9c1f14ef2d08fdb0fc3978dbe0ccb Mon Sep 17 00:00:00 2001 From: William FH <13333726+hinthornw@users.noreply.github.com> Date: Mon, 3 Feb 2025 09:59:03 -0800 Subject: [PATCH 2/2] Update docs/docs/concepts/deployment_options.md --- docs/docs/concepts/deployment_options.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/concepts/deployment_options.md b/docs/docs/concepts/deployment_options.md index 2b497b8359..e5c0d680f2 100644 --- a/docs/docs/concepts/deployment_options.md +++ b/docs/docs/concepts/deployment_options.md @@ -51,7 +51,7 @@ For more information, please see: The LangGraph Platform Deployments view (within LangSmith SaaS and self-hosted LangSmith) is not available for Self-Hosted Lite LangGraph deployments. Self-hosted LangGraph deployments are managed externally from LangSmith (e.g. there is no UI to manage these deployments). -The Self-Hosted Lite deployment option is a free (up to 1 million nodes executed per annum), limited version of LangGraph Platform that you can run locally or in a self-hosted manner. +The Self-Hosted Lite deployment option is a free (up to 1 million nodes executed per year), limited version of LangGraph Platform that you can run locally or in a self-hosted manner. With a Self-Hosted Lite deployment, you are responsible for managing the infrastructure, including setting up and maintaining required databases and Redis instances.