Skip to content

docs: update UI references to connection strings #1449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rodrigobnogueira wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update UI references to connection strings #1449

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,20 @@ You are reading the documentation for version 3. If you are looking for version

## Before Installation

> Azure portal interfaces may change; always refer to the latest Microsoft documentation for navigation.

For Cosmos DB (NoSQL ONLY)

1. Create a Cosmos DB account and resource ([read more](https://learn.microsoft.com/azure/cosmos-db/nosql/quickstart-portal))
2. Note down the "URI", Database name and the "Primary Key" (or "Secondary Key") - You will need them later
2. Retrieve the URI (Endpoint), Primary Key, and Database Name from your Cosmos DB account in the Azure portal:
- Locate your Cosmos DB account's connection details (often under a section like "Keys" or "Connection Strings").
- You can extract these from the primary connection string, which follows the format: `AccountEndpoint=<YOUR_ENDPOINT>;AccountKey=<YOUR_KEY>;`
- You will use the `AccountEndpoint` value as `AZURE_COSMOS_DB_ENDPOINT` and the `AccountKey` value as `AZURE_COSMOS_DB_KEY` in your `.env` file later.

For Table Storage

1. Create a Storage account and resource ([read more](https://learn.microsoft.com/azure/storage/tables/table-storage-quickstart-portal))
2. Note down the "Connection string" - You will need it later
2. Retrieve the connection string from your Storage account in the Azure portal (often under "Access keys" or "Connection strings"). For detailed steps, see [Manage storage account keys](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#get-connection-string). You will need it later.

## Installation

Expand Down