Required docker configuration completed

Author: EstoesMoises

.dockerignore

@@ -2,6 +2,7 @@ dist-types
 node_modules
 packages/*/dist
 packages/*/node_modules
+packages/backend/.env
 plugins/*/dist
 plugins/*/node_modules
 *.local.yaml

Dockerfile

@@ -1,3 +1,11 @@
+# DO NOT USE THIS IN PRODUCTION
+# 
+# This Dockerfile builds a Docker image for a pre-configured Backstage instance
+# with the Stack Overflow plugins installed. It’s designed as a quick way to try 
+# out the integration without having to set it up yourself. 
+#
+# This is not intended for production use.
+
 # Stage 1 - Create yarn install skeleton layer
 FROM node:20-bookworm-slim AS packages
 
@@ -105,9 +113,9 @@ COPY --chown=node:node app-config*.yaml ./
 COPY --chown=node:node examples ./examples
 
 # This switches many Node.js dependencies to production mode.
-ENV NODE_ENV=production
+ENV NODE_ENV=development
 
 # This disables node snapshot for Node 20 to work with the Scaffolder
 ENV NODE_OPTIONS="--no-node-snapshot"
 
-CMD ["node", "packages/backend", "--config", "app-config.yaml", "--config", "app-config.production.yaml"]
+CMD ["node", "packages/backend", "--config", "app-config.docker-local.yaml"]

app-config.docker-local.yaml

@@ -0,0 +1,131 @@
+# DO NOT USE THIS IN PRODUCTION.
+# 
+# This app-config is used to run a development environment with Docker.
+# It resembles the app-config.yaml file which is not intended for production use.
+
+app:
+  title: Scaffolded Backstage App
+  baseUrl: http://localhost:7007
+
+organization:
+  name: My Company
+
+stackoverflow:
+  baseUrl: ${STACK_OVERFLOW_INSTANCE_URL}
+  # teamName: ${STACK_OVERFLOW_TEAM_NAME}
+
+  apiAccessToken: ${STACK_OVERFLOW_API_ACCESS_TOKEN}
+  # The API Access Token is used for the Questions' collator, a no-expiry, read-only token is recommended.
+
+  clientId: ${STACK_OVERFLOW_CLIENT_ID}
+  # The clientid must be for an API Application with read-write access.
+
+  redirectUri: ${STACK_OVERFLOW_REDIRECT_URI}
+  # If no redirectUri is specified this will return to https://<backstage-domain>/stack-overflow-teams
+
+backend:
+  # Used for enabling authentication, secret is shared by all backend plugins
+  # See https://backstage.io/docs/auth/service-to-service-auth for
+  # information on the format
+  # auth:
+  #   keys:
+  #     - secret: ${BACKEND_SECRET}
+  baseUrl: http://localhost:7007
+  listen:
+    port: 7007
+    # Uncomment the following host directive to bind to specific interfaces
+    # host: 127.0.0.1
+  csp:
+    connect-src: ["'self'", 'http:', 'https:']
+    # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
+    # Default Helmet Content-Security-Policy values can be removed by setting the key to false
+  cors:
+    origin: http://localhost:7007
+    methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
+    credentials: true
+  # This is for local development only, it is not recommended to use this in production
+  # The production database configuration is stored in app-config.production.yaml
+  database:
+    client: better-sqlite3
+    connection: ':memory:'
+  # workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
+
+integrations:
+  github:
+    - host: github.com
+      # This is a Personal Access Token or PAT from GitHub. You can find out how to generate this token, and more information
+      # about setting up the GitHub integration here: https://backstage.io/docs/integrations/github/locations#configuration
+      token: ${GITHUB_TOKEN}
+    ### Example for how to add your GitHub Enterprise instance using the API:
+    # - host: ghe.example.net
+    #   apiBaseUrl: https://ghe.example.net/api/v3
+    #   token: ${GHE_TOKEN}
+
+proxy:
+  ### Example for how to add a proxy endpoint for the frontend.
+  ### A typical reason to do this is to handle HTTPS and CORS for internal services.
+  # endpoints:
+  #   '/test':
+  #     target: 'https://example.com'
+  #     changeOrigin: true
+
+# Reference documentation http://backstage.io/docs/features/techdocs/configuration
+# Note: After experimenting with basic setup, use CI/CD to generate docs
+# and an external cloud storage when deploying TechDocs for production use-case.
+# https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-basic-to-recommended-deployment-approach
+techdocs:
+  builder: 'local' # Alternatives - 'external'
+  generator:
+    runIn: 'docker' # Alternatives - 'local'
+  publisher:
+    type: 'local' # Alternatives - 'googleGcs' or 'awsS3'. Read documentation for using alternatives.
+
+auth:
+  # see https://backstage.io/docs/auth/ to learn about auth providers
+  providers:
+    # See https://backstage.io/docs/auth/guest/provider
+    guest: {}
+
+scaffolder:
+  # see https://backstage.io/docs/features/software-templates/configuration for software template options
+
+catalog:
+  import:
+    entityFilename: catalog-info.yaml
+    pullRequestBranchName: backstage-integration
+  rules:
+    - allow: [Component, System, API, Resource, Location]
+  locations:
+    # Local example data, file locations are relative to the backend process, typically `packages/backend`
+    - type: file
+      target: ../../examples/entities.yaml
+
+    # Local example template
+    - type: file
+      target: ../../examples/template/template.yaml
+      rules:
+        - allow: [Template]
+
+    # Local example organizational data
+    - type: file
+      target: ../../examples/org.yaml
+      rules:
+        - allow: [User, Group]
+
+    ## Uncomment these lines to add more example data
+    # - type: url
+    #   target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
+
+    ## Uncomment these lines to add an example org
+    # - type: url
+    #   target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
+    #   rules:
+    #     - allow: [User, Group]
+
+kubernetes:
+  # see https://backstage.io/docs/features/kubernetes/configuration for kubernetes configuration options
+
+# see https://backstage.io/docs/permissions/getting-started for more on the permission framework
+permission:
+  # setting this to `false` will disable permissions
+  enabled: true