Skip to content

chore: update documentation for AWS Bedrock usage #57

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

Merged
veerareddyvishal144 merged 1 commit into from
Feb 23, 2026
+30 −12
Merged

chore: update documentation for AWS Bedrock usage #57

Show file tree
Hide file tree
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
18 changes: 15 additions & 3 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# ==============================================================================
# LYNKR CONFIGURATION - All Environment Variables
# Copy this file to .env and fill in your values
#
# FORMAT: Use plain KEY=VALUE syntax (no "export" prefix).
# Good: MODEL_PROVIDER=bedrock
# Bad: export MODEL_PROVIDER=bedrock
# ==============================================================================

# ==============================================================================
Expand Down Expand Up @@ -91,10 +95,18 @@ OPENROUTER_MAX_TOOLS_FOR_ROUTING=15
# AWS Bedrock Configuration
# ==============================================================================

# Generate from AWS Console → Bedrock → API Keys
# AWS_BEDROCK_API_KEY=your-bedrock-bearer-token
# IMPORTANT: Lynkr uses Bedrock API Key authentication (Bearer token),
# NOT standard IAM credentials (AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY).
#
# Setup:
# 1. Open AWS Console → Amazon Bedrock → API keys (left sidebar)
# 2. Generate a long-term or short-term API key
# 3. Copy the key (starts with ABSK) and set it below
# Docs: https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys-use.html
#
# AWS_BEDROCK_API_KEY=ABSK...your-bedrock-api-key
# AWS_BEDROCK_REGION=us-east-1
# AWS_BEDROCK_MODEL_ID=anthropic.claude-3-5-sonnet-20241022-v2:0
# AWS_BEDROCK_MODEL_ID=us.anthropic.claude-3-5-sonnet-20241022-v2:0

# ==============================================================================
# llama.cpp Configuration (Local GGUF Models)
Expand Down
4 changes: 2 additions & 2 deletions documentation/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,9 @@ npm install -g lynkr

# Configure
export MODEL_PROVIDER=bedrock
export AWS_BEDROCK_API_KEY=AKIAIOSFODNN7EXAMPLE
export AWS_BEDROCK_API_KEY=ABSK...your-bedrock-api-key
export AWS_BEDROCK_REGION=us-east-1
export AWS_BEDROCK_MODEL_ID=anthropic.claude-3-5-sonnet-20241022-v2:0
export AWS_BEDROCK_MODEL_ID=us.anthropic.claude-3-5-sonnet-20241022-v2:0

# Start
lynkr start
Expand Down
20 changes: 13 additions & 7 deletions documentation/providers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,19 +137,25 @@ LMSTUDIO_ENDPOINT=http://workstation.local:1234

```env
MODEL_PROVIDER=bedrock
AWS_BEDROCK_API_KEY=your-bearer-token
AWS_BEDROCK_API_KEY=ABSK...your-api-key
AWS_BEDROCK_REGION=us-east-1
AWS_BEDROCK_MODEL_ID=anthropic.claude-3-5-sonnet-20241022-v2:0
AWS_BEDROCK_MODEL_ID=us.anthropic.claude-3-5-sonnet-20241022-v2:0
```

#### Getting AWS Bedrock API Key

> **Important:** Lynkr uses Bedrock **API Key** authentication (Bearer token), NOT standard IAM credentials (`AWS_ACCESS_KEY_ID`/`AWS_SECRET_ACCESS_KEY`/`AWS_SESSION_TOKEN`). Standard IAM/SigV4 credentials will not work.

1. Log in to [AWS Console](https://console.aws.amazon.com/)
2. Navigate to **Bedrock** → **API Keys**
3. Click **Generate API Key**
4. Copy the bearer token (this is your `AWS_BEDROCK_API_KEY`)
5. Enable model access in Bedrock console
6. See: [AWS Bedrock API Keys Documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys-generate.html)
2. Navigate to **Amazon Bedrock** → **API keys** (in the left sidebar)
3. Generate a long-term or short-term API key
4. Copy the API key (starts with `ABSK`) — this is your `AWS_BEDROCK_API_KEY`
5. Enable model access in Bedrock console for your desired models
6. See: [AWS Bedrock API Keys Documentation](https://docs.aws.amazon.com/bedrock/latest/userguide/api-keys-use.html)

> **Common Mistake:** Setting `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` will NOT work with Lynkr. You must use the Bedrock-specific API Key (`AWS_BEDROCK_API_KEY`, starts with `ABSK`).

> **Model IDs:** When using API key auth, use inference profile model IDs with the region prefix (e.g., `us.anthropic.claude-3-5-sonnet-20241022-v2:0` instead of `anthropic.claude-3-5-sonnet-20241022-v2:0`).

#### Available Regions

Expand Down
Loading