docs(weaviate): update doc with new configs

juspay · May 24, 2024 · 1f5e927 · 1f5e927
1 parent c48d048
commit 1f5e927
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/doc/services.md b/doc/services.md
@@ -21,5 +21,6 @@ short-title: Services
   - [[tempo]]
 - [[prometheus]]#
 - [[cassandra]]#
+- [[weaviate]]#
 
 [gh]: https://github.com/juspay/services-flake/issues/132
diff --git a/doc/weaviate.md b/doc/weaviate.md
@@ -1,5 +1,9 @@
 # Weaviate
 
+[Weaviate] is an open-source vector database that stores both objects and vectors, allowing for the combination of vector search with structured filtering with the fault tolerance and scalability of a cloud-native database.
+
+[Weaviate]: https://github.com/weaviate/weaviate
+
 {#start}
 
 ## Getting started
@@ -15,6 +19,27 @@
 
 ## Tips & Tricks
 
+{#envs}
+
+### Environment variables
+
+To see list of environment variables, see [this link](https://weaviate.io/developers/weaviate/config-refs/env-vars).
+
+```nix
+{
+  services.weaviate."weaviate1" = {
+    enable = true;
+    envs = {
+      AUTHENTICATION_ANONYMOUS_ACCESS_ENABLED = true;
+      QUERY_DEFAULTS_LIMIT = 100;
+      DISABLE_TELEMETRY = true;
+      LIMIT_RESOURCES = true;
+      ENABLE_MODULES = ["text2vec-openai" "generative-openai"];
+    };
+  };
+}
+```
+
 {#port}
 
 ### Use a different port
@@ -36,11 +61,7 @@
 {
   services.weaviate."weaviate1" = {
     enable = true;
-    settings = {
-      persistence = {
-        dataPath = "./data";
-      };
-    };
+    dataDir = "./data";
   };
 }
 ```