Skip to content

Commit

Permalink
docs: Misc improvements (#1252)
Browse files Browse the repository at this point in the history
* docs: misc-updates

* chore: host kwarg quickstart-cloud.md
  • Loading branch information
Anush008 authored Oct 25, 2024
1 parent c82bcff commit a561499
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ aliases:

# Configuration

Qdrant ships with sensible defaults for collection and network settings that are suitable for most use cases. You can view these default settings in the [Qdrant source](https://github.com/qdrant/qdrant/blob/master/config/config.yaml). If you need to customize these settings, you can do so using configuration files and environment variables.
Qdrant ships with sensible defaults for collection and network settings that are suitable for most use cases. You can view these defaults in the [Qdrant source](https://github.com/qdrant/qdrant/blob/master/config/config.yaml). If you need to customize the settings, you can do so using configuration files and environment variables.

<aside role="status">
Qdrant Cloud does not allow modifying the Qdrant configuration.
Expand Down
78 changes: 77 additions & 1 deletion qdrant-landing/content/documentation/quickstart-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,87 @@ aliases:
## Access the cluster dashboard

1. Go to your **Clusters**. Under **Actions**, open the **Dashboard**.
2. Paste your new API key here. If you lost it, make another in **Access Management**.
2. Paste your new API key here. You can revoke and create new API keys in **Access Management**.
3. The key will grant you access to your Qdrant instance. Now you can see the cluster Dashboard.

![access the dashboard](/docs/gettingstarted/gui-quickstart/access-dashboard.png)

## Authenticate via SDKs

Now that you have your cluster and key, you can use our official SDKs to access Qdrant Cloud from within your application.

```bash
curl \
-X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
--header 'api-key: <your-api-key>'

# Alternatively, you can use the `Authorization` header with the `Bearer` prefix
curl \
-X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
--header 'Authorization: Bearer <your-api-key>'
```

```python
from qdrant_client import QdrantClient

qdrant_client = QdrantClient(
host="xyz-example.eu-central.aws.cloud.qdrant.io",
api_key="<your-api-key>",
)
```

```typescript
import { QdrantClient } from "@qdrant/js-client-rest";

const client = new QdrantClient({
host: "xyz-example.eu-central.aws.cloud.qdrant.io",
apiKey: "<your-api-key>",
});
```

```rust
use qdrant_client::Qdrant;

let client = Qdrant::from_url("https://xyz-example.eu-central.aws.cloud.qdrant.io:6334")
.api_key("<your-api-key>")
.build()?;
```

```java
import io.qdrant.client.QdrantClient;
import io.qdrant.client.QdrantGrpcClient;

QdrantClient client =
new QdrantClient(
QdrantGrpcClient.newBuilder(
"xyz-example.eu-central.aws.cloud.qdrant.io",
6334,
true)
.withApiKey("<your-api-key>")
.build());
```

```csharp
using Qdrant.Client;

var client = new QdrantClient(
host: "xyz-example.eu-central.aws.cloud.qdrant.io",
https: true,
apiKey: "<your-api-key>"
);
```

```go
import "github.com/qdrant/go-client/qdrant"

client, err := qdrant.NewClient(&qdrant.Config{
Host: "xyz-example.eu-central.aws.cloud.qdrant.io",
Port: 6334,
APIKey: "<your-api-key>",
UseTLS: true,
})
```

## Try the Tutorial sandbox

1. Open the interactive **Tutorial**. Here, you can test basic Qdrant API requests.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
}
figcaption,
figcaption p {
color: $caption-color;
font-size: $caption-size;
text-align: center;
margin-top: $margin;
Expand Down

0 comments on commit a561499

Please sign in to comment.