[Docs] Add diagrams (#2834)

langchain-ai · Dec 19, 2024 · 5a580ae · 5a580ae
2 parents fa61be9 + 47a0e09
commit 5a580ae
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 1 deletion.
diff --git a/docs/docs/tutorials/auth/getting_started.md b/docs/docs/tutorials/auth/getting_started.md
@@ -5,6 +5,16 @@
     1. Basic Authentication (you are here) - Control who can access your bot
     2. [Resource Authorization](resource_auth.md) - Let users have private conversations
     3. [Production Auth](add_auth_server.md) - Add real user accounts and validate using OAuth2
+!!! tip "Prerequisites"
+
+    This guide assumes basic familiarity with the following concepts:
+
+      *  [**Authentication & Access Control**](../../concepts/auth.md)
+      *  [**LangGraph Platform**](../../concepts/index.md#langgraph-platform)
+
+!!! note "Python only"
+
+    We currently only support custom authentication and authorization in Python deployments with `langgraph-api>=0.0.11`. Support for LangGraph.JS will be added soon.
 
 In this tutorial, we will build a chatbot that only lets specific users access it. We'll start with the LangGraph template and add token-based security step by step. By the end, you'll have a working chatbot that checks for valid tokens before allowing access.
 
@@ -32,9 +42,14 @@ If everything works, the server should start and open the studio in your browser
 > This in-memory server is designed for development and testing.
 > For production use, please use LangGraph Cloud.
 
+The graph should run, and if you were to self-host this on the public internet, anyone could access it!
+
+![No auth](./img/no_auth.png)
+
 Now that we've seen the base LangGraph app, let's add authentication to it! In part 1, we will start with a hard-coded token for illustration purposes.
 We will get to a "production-ready" authentication scheme in part 3, after mastering the basics.
 
+
 ## Adding Authentication
 
 The [`Auth`](../../cloud/reference/sdk/python_sdk_ref.md#langgraph_sdk.auth.Auth) object lets you register an authentication function that the LangGraph platform will run on every request. This function receives each request and decides whether to accept or reject.
@@ -114,7 +129,11 @@ langgraph dev --no-browser
     }
     ```
 
-Now let's try to chat with our bot. Run the following code in a file or notebook:
+Now let's try to chat with our bot. If we've implemented authentication correctly, we should only be able to access the bot if we provide a valid token in the request header. Users will still, however, be able to access each other's resources until we add [resource authorization handlers](../../concepts/auth.md#resource-authorization) in the next section of our tutorial.
+
+![Authentication, no authorization handlers](./img/authentication.png)
+
+Run the following code in a file or notebook:
 
 ```python
 from langgraph_sdk import get_client

diff --git a/docs/docs/tutorials/auth/img/authentication.png b/docs/docs/tutorials/auth/img/authentication.png
diff --git a/docs/docs/tutorials/auth/img/authorization.png b/docs/docs/tutorials/auth/img/authorization.png
diff --git a/docs/docs/tutorials/auth/img/no_auth.png b/docs/docs/tutorials/auth/img/no_auth.png
diff --git a/docs/docs/tutorials/auth/resource_auth.md b/docs/docs/tutorials/auth/resource_auth.md
@@ -8,6 +8,8 @@
 
 In this tutorial, we will extend our chatbot to give each user their own private conversations. We'll add [resource-level access control](../../concepts/auth.md#resource-level-access-control) so users can only see their own threads.
 
+![Authorization handlers](./img/authorization.png)
+
 ## Understanding Resource Authorization
 
 In the last tutorial, we controlled who could access our bot. But right now, any authenticated user can see everyone else's conversations! Let's fix that by adding [resource authorization](../../concepts/auth.md#resource-authorization).