stackoverflowdocker/stackoverflow-backstage-demo

By stackoverflowdocker

•Updated 2 months ago

A development backstage environment configured to use the integration with Stack Overflow for Teams.

Image
0

384

stackoverflowdocker/stackoverflow-backstage-demo repository overview

ā šŸ“¦ Backstage instance with Stack Internal integration

If you'd like to quickly test how the Stack Overflow internal integration works inside Backstage — without having to set up your own Backstage environment — you can use this pre-built Docker image:

Image: stackoverflowdocker/stackoverflow-backstage-demo:latest

This image runs a Backstage instance pre-configured with the Stack Internal plugin. You only need to pass a few environment variables when starting the container to hook it up to your Stack Internal instance.

ā šŸ“¦ Required Environment Variables

⁠For Enterprise Customers:

Variable

Description

STACK_OVERFLOW_INSTANCE_URL

The base URL of your Stack Internal Enterprise instance.

STACK_OVERFLOW_API_ACCESS_TOKEN

A read-only, no-expiry API access token generated for your Stack Internal Enterprise instance. This token is used by the plugin's search collator to index questions into Backstage search.

STACK_OVERFLOW_CLIENT_ID

The OAuth Client ID from your Stack Internal application. This is required to enable the secure question creation flow from within Backstage.

STACK_OVERFLOW_REDIRECT_URI

The redirect URI where Stack Internal 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.

⁠For Basic and Business Customers:

Variable

Description

STACK_OVERFLOW_TEAM_NAME

The team name or team slug from your Stack Internal account.

STACK_OVERFLOW_API_ACCESS_TOKEN

A read-only, no-expiry API access token generated for your Stack Internal instance. Used for indexing content.

Note: Question creation is not supported on the Basic tier.

ā šŸ“– How to generate your API Access Token

Basic and Business customers can follow the official Stack Internal guide to create a Personal Access Token (PAT) for API authentication:

šŸ‘‰ Personal Access Tokens (PATs) for API Authentication⁠

This token should have read-only access and no expiration to be used for indexing questions into Backstage search.

⁠🐳 Example Docker Run Command

docker run -p 7007:7007 \
  -e STACK_OVERFLOW_INSTANCE_URL=https://support-autotest.stackenterprise.co \
  -e STACK_OVERFLOW_API_ACCESS_TOKEN='CasdasdasdaDQyrqdfQ))' \
  -e STACK_OVERFLOW_CLIENT_ID=19 \
  -e STACK_OVERFLOW_REDIRECT_URI=http://redirectmeto.com/http://localhost:7007/stack-overflow-teams \
  stackoverflowdocker/stackoverflow-backstage-demo

Once running, the Backstage app will be accessible at http://localhost:7007

Tag summary

Content type

Image

Digest

sha256:0e9a55489…

Size

298.7 MB

Last updated

2 months ago

docker pull stackoverflowdocker/stackoverflow-backstage-demo