update docs to use the new CLI as the default happy path (#121)

* update docs to use the new CLI

* Updated docs

* Clean up auth

* HTTP Client already exitsts

---------

Co-authored-by: atroyn <anton.troynikov@gmail.com>

Author: jeffchuber

docs/api-reference.md

@@ -5,11 +5,11 @@ title: "📖 API Cheatsheet"
 
 # 📖 API Cheatsheet
 
-:::note 
+:::note
 This is a quick cheatsheet of the API. For full API docs, refer to the JS and Python docs in the sidebar.
 :::
 
-***
+---
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
@@ -21,8 +21,7 @@ import TabItem from '@theme/TabItem';
 <TabItem value="js" label="JavaScript"></TabItem>
 </Tabs>
 
-***
-
+---
 
 <Tabs queryString groupId="lang" className="hideTabSwitcher">
 <TabItem value="py" label="Python">
@@ -47,7 +46,9 @@ client = chromadb.PersistentClient(path="/path/to/data")
 
 ### Run chroma just as a client to talk to a backend service
 
-For many use cases, an in-memory database will not cut it. Run `docker-compose up -d --build` to run a persistent backend in Docker. Simply update your API initialization and then use the API the same way as before.
+You can run Chroma a standalone Chroma server using the Chroma command line. Run `chroma run --path /db_path` to run a server.
+
+Then update your API initialization and then use the API the same way as before.
 
 ```python
 import chromadb
@@ -151,12 +152,12 @@ collection.delete()
 
 ### Run the backend
 
-Run `docker-compose up -d --build` to run a backend in Docker on your local computer. 
+Run `chroma run --path /db_path` to run the Chroma backend as a standalone server on your local computer.
 
 ## Initialize client - JS
 
 ```javascript
-import { ChromaClient } from 'chromadb'
+import { ChromaClient } from "chromadb";
 const client = new ChromaClient();
 ```
 
@@ -170,23 +171,23 @@ Collections are similar to AWS s3 buckets in their naming requirements because t
 
 ```javascript
 // list all collections
-await client.listCollections()
+await client.listCollections();
 
 // make a new collection
-const collection = await client.createCollection({name: "testname"})
+const collection = await client.createCollection({ name: "testname" });
 
 // get an existing collection
-const collection = await client.getCollection({name: "testname"})
+const collection = await client.getCollection({ name: "testname" });
 
 // delete a collection
-await client.deleteCollection({name: "testname"})
+await client.deleteCollection({ name: "testname" });
 ```
 
 ### Utility methods
 
 ```javascript
 // resets entire database - this *cant* be undone!
-await client.reset()
+await client.reset();
 ```
 
 ## Methods on Collection
@@ -202,7 +203,7 @@ await collection.add({
     embeddings: [1.5, 2.9, 3.4],
     metadatas: {"source": "my_source"},
     documents: "This is a document",
-}) 
+})
 // or many, up to 100k+!
 await collection.add({
     ids: ["uri9", "uri10"],
@@ -243,8 +244,6 @@ await collection.delete()
 
 ```
 
-
 </TabItem>
 
 </Tabs>
-

docs/deployment.md

@@ -5,10 +5,12 @@ title: "☁️ Deployment"
 
 :::caution Alpha Status
 Chroma Server is currently in Alpha. We are working hard to move Chroma from an in-memory single-process oriented library to a distributed production-grade DB!
+
 - [x] Alpha <- Currently
 - [ ] Technical Preview - ~1 month away, powered by a completely new backend
 - [ ] Full production
 - [ ] GA - General Availability
+
 :::
 
 # ☁️ Deployment
@@ -21,12 +23,49 @@ provided a very simple AWS CloudFormation template to experiment with
 deploying Chroma to EC2 on AWS.
 
 ## Hosted Chroma
-We want to offer hosted Chroma, and we need your help. 
+
+We want to offer hosted Chroma, and we need your help.
 
 Fill out the survey to jump the wait-list. Coming Q3 2023.
 
 [📝 30 second survey](https://airtable.com/shrOAiDUtS2ILy5vZ)
 
+## Docker
+
+You can run a Chroma server in a Docker container.
+
+You can get the Chroma Docker image from [Docker Hub](https://hub.docker.com/r/chromadb/chroma), or from the [Chroma GitHub Container Registry](https://github.com/chroma-core/chroma/pkgs/container/chroma)
+
+```sh
+docker pull chromadb/chroma
+docker run -p 8000:8000 chromadb/chroma
+```
+
+You can also build the Docker image yourself from the Dockerfile in the [Chroma GitHub repository](https://github.com/chroma-core/chroma)
+
+```sh
+git clone git@github.com:chroma-core/chroma.git
+cd chroma
+docker-compose up -d --build
+```
+
+The Chroma client can then be configured to connect to the server running in the Docker container.
+
+```python
+import chromadb
+chroma_client = chromadb.HttpClient(host='localhost', port=8000)
+```
+
+### Authentication with Docker
+
+By default, the Docker image will run with no authentication. Follow the [Authentication](./usage-guide#authentication) section of the Usage Guide to configure authentication in the Docker container.
+
+You can also create a `.chroma_env` file setting the required environment variables and pass it to the Docker container with the `--env-file` flag when running the container.
+
+```sh
+docker run --env-file ./.chroma_env -p 8000:8000 chromadb/chroma
+```
+
 ## Simple AWS Deployment
 
 :warning: Chroma and its underlying database need at least 2gb of RAM,
@@ -47,7 +86,6 @@ serious production use (with high availability, backups, etc.) please
 read and understand the CloudFormation template and use it as a basis
 for what you need, or reach out to the Chroma team for assistance.
 
-
 ### Step 1: Get an AWS Account
 
 You will need an AWS Account. You can use one you already have, or
@@ -65,17 +103,20 @@ and will be using environment variables to configure AWS.
 
 Export the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables in your shell:
 
-
 ```
-export AWS_ACCESS_KEY_ID=****************
-export AWS_SECRET_ACCESS_KEY=**********************
+
+export AWS_ACCESS_KEY_ID=**\*\***\*\*\*\***\*\***
+export AWS_SECRET_ACCESS_KEY=****\*\*****\*\*****\*\*****
+
 ```
 
 You can also configure AWS to use a region of your choice using the
 `AWS_REGION` environment variable:
 
 ```
+
 export AWS_REGION=us-east-1
+
 ```
 
 ### Step 3: Run CloudFormation
@@ -85,7 +126,9 @@ Chroma publishes Cloudformation templates to S3 for each release.
 To launch the template using AWS CloudFormation, run the following command line invocation:
 
 ```
+
 aws cloudformation create-stack --stack-name my-chroma-stack --template-url https://s3.amazonaws.com/public.trychroma.com/cloudformation/latest/chroma.cf.json
+
 ```
 
 Replace `--stack-name my-chroma-stack` with a different stack name, if you wish.
@@ -94,7 +137,9 @@ Wait a few minutes for the server to boot up, and Chroma will be
 available! You can get the public IP address of your new Chroma server using the AWS console, or using the following command:
 
 ```
+
 aws cloudformation describe-stacks --stack-name my-chroma-stack --query 'Stacks[0].Outputs'
+
 ```
 
 ### Step 4: Customize the Stack (optional)
@@ -114,15 +159,13 @@ above, but on a `m5.4xlarge` EC2 instance, and adding a KeyPair named
 `mykey` so anyone with the associated private key can SSH into the
 machine:
 
-
-```
-aws cloudformation create-stack --stack-name my-chroma-stack --template-url https://s3.amazonaws.com/public.trychroma.com/cloudformation/latest/chroma.cf.json \
-    --parameters ParameterKey=KeyName,ParameterValue=mykey \
-                 ParameterKey=InstanceType,ParameterValue=m5.4xlarge
 ```
 
+aws cloudformation create-stack --stack-name my-chroma-stack --template-url https://s3.amazonaws.com/public.trychroma.com/cloudformation/latest/chroma.cf.json \
+ --parameters ParameterKey=KeyName,ParameterValue=mykey \
+ ParameterKey=InstanceType,ParameterValue=m5.4xlarge
 
-
+```
 
 ### Step 5: Configure the Chroma Library
 
@@ -132,33 +175,37 @@ you need to do is configure it to use the server's IP address and port
 
 ###### Using Environment Variables
 
-
 ```
+
 export CHROMA_API_IMPL=rest
 export CHROMA_SERVER_HOST=<server IP address>
 export CHROMA_SERVER_HTTP_PORT=8000
-```
 
+```
 
 ###### In Code
 
 ```
+
 import chromadb
 from chromadb.config import Settings
 chroma = chromadb.HttpClient(host=<server IP address>, port=8000)
+
 ```
 
 ### Step 6: Clean Up (optional).
 
 To destroy the stack and remove all AWS resources, use the AWS CLI `delete-stack` command.
 
 ```
+
 aws cloudformation delete-stack --stack-name my-chroma-stack
+
 ```
 
 :warning: This will destroy all the data in your Chroma database,
 unless you've taken a snapshot or otherwise backed it up.
 
 ### Troubleshooting
 
-If you get an error saying `No default VPC for this user` when creating `ChromaInstanceSecurityGroup`, head to [AWS VPC section]( https://us-east-1.console.aws.amazon.com/vpc/home?region=us-east-1#vpcs) and create a default VPC for your user.
+If you get an error saying `No default VPC for this user` when creating `ChromaInstanceSecurityGroup`, head to [AWS VPC section](https://us-east-1.console.aws.amazon.com/vpc/home?region=us-east-1#vpcs) and create a default VPC for your user.