Skip to content

Commit 15410e7

Browse files
committed
Updated README
1 parent b60ecd7 commit 15410e7

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

README.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,33 @@ This image runs a Backstage instance pre-configured with the Stack Overflow for
4040

4141
---
4242

43-
### Required Environment Variables
43+
## 📦 Required Environment Variables
4444

45-
| Variable | Description |
46-
|:----------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
47-
| `STACK_OVERFLOW_INSTANCE_URL` | The base URL of your Stack Overflow for Teams (Enterprise) instance. |
48-
| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Overflow Enterprise instance. This token is used by the plugin's search collator to index questions into Backstage search. |
49-
| `STACK_OVERFLOW_CLIENT_ID` | The OAuth Client ID from your Stack Overflow application. This is required to enable the secure question creation flow from within Backstage. |
45+
### For **Enterprise** Customers:
46+
47+
| Variable | Description |
48+
| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
49+
| `STACK_OVERFLOW_INSTANCE_URL` | The base URL of your Stack Overflow for Teams (Enterprise) instance. |
50+
| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Overflow Enterprise instance. This token is used by the plugin’s search collator to index questions into Backstage search. |
51+
| `STACK_OVERFLOW_CLIENT_ID` | The OAuth Client ID from your Stack Overflow application. This is required to enable the secure question creation flow from within Backstage. |
5052
| `STACK_OVERFLOW_REDIRECT_URI` | The redirect URI where Stack Overflow should send users after completing the OAuth authentication flow. By default, this is `{app.baseUrl}/stack-overflow-teams`. For local development, you can use a redirect service like `http://redirectmeto.com/http://localhost:7007/stack-overflow-teams`. |
5153

54+
---
55+
56+
### For **Basic** and **Business** Customers:
57+
58+
| Variable | Description |
59+
| :-------------------------------- | :----------------------------------------------------------------------------------------------------------------------- |
60+
| `STACK_OVERFLOW_TEAM_NAME` | The **team name** or **team slug** from your Stack Overflow for Teams account. |
61+
| `STACK_OVERFLOW_API_ACCESS_TOKEN` | A **read-only, no-expiry** API access token generated for your Stack Overflow Teams instance. Used for indexing content. |
62+
63+
📖 How to generate your API Access Token
64+
65+
Basic and Business customers can follow the official Stack Overflow for Teams guide to create a Personal Access Token (PAT) for API authentication:
66+
67+
👉 [Personal Access Tokens (PATs) for API Authentication](https://stackoverflowteams.help/en/articles/10908790-personal-access-tokens-pats-for-api-authentication)
68+
69+
This token should have read-only access and no expiration to be used for indexing questions into Backstage search.
5270

5371
---
5472

0 commit comments

Comments
 (0)