Update API key format in self-hosted documentation (#199)

coderabbitai · Jan 16, 2025 · becf94e · becf94e
1 parent 74aaf1e
commit becf94e
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 4 deletions.
diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md
@@ -86,7 +86,7 @@ AZURE_DEVOPS_BOT_TOKEN=<personal-access-token>
 AZURE_DEVOPS_BOT_USERNAME=<bot-user-username>
 CODERABBIT_LICENSE_KEY=<license-key>
 
-CODERABBIT_API_KEY=[<coderabbitai-api-key>]
+CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]
 

diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md
@@ -77,8 +77,9 @@ BITBUCKET_SERVER_URL=<bitbucket-server-url>/rest
 BITBUCKET_SERVER_WEBHOOK_SECRET=<webhook-secret>
 BITBUCKET_SERVER_BOT_TOKEN=<personal-access-token>
 BITBUCKET_SERVER_BOT_USERNAME=<bot-user-username>
+
 CODERABBIT_LICENSE_KEY=<license-key>
-CODERABBIT_API_KEY=[<coderabbitai-api-key>]
+CODERABBIT_API_KEY=<coderabbitai-api-key>
 
 # Optional Features
 ENABLE_LEARNINGS=[true]

diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md
@@ -22,6 +22,7 @@ Set the following Repository permissions:
 - Issues: Read & write
 - Metadata: Read-only
 - Pull requests: Read & write
+- Actions: Read-only
 
 Set the following Organization permissions:
 
@@ -100,7 +101,7 @@ GITHUB_APP_PEM_FILE=<flattened-pem-file>
 
 CODERABBIT_LICENSE_KEY=<license-key>
 
-CODERABBIT_API_KEY=[<coderabbitai-api-key>]
+CODERABBIT_API_KEY=<coderabbitai-api-key>
 # This will use your CodeRabbit API key to store learnings on our servers.
 ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]

diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md
@@ -91,7 +91,7 @@ GITLAB_BOT_TOKEN=<personal-access-token>
 GITLAB_WEBHOOK_SECRET=<webhook-secret-key>
 CODERABBIT_LICENSE_KEY=<license-key>
 
-CODERABBIT_API_KEY=[<coderabbitai-api-key>]
+CODERABBIT_API_KEY=<coderabbitai-api-key>
 ENABLE_LEARNINGS=[true]
 ENABLE_METRICS=[true]