@seatgeek/backstage-plugin-awards-backend
This plugin provides the backend API for the awards plugin.

This plugin relies on Backstage authentication
in order to enforce ownership of awards. Please follow the documentation to
enable authentication before attempting to use this plugin!
Currently we support only SQLite
and PostgreSQL
databases.
Installation
Install the @seatgeek/backstage-plugin-awards-backend package using the new backend:
backend.add(import('@seatgeek/backstage-plugin-awards-backend'));
Configuration
Image storage (required)
The awards-backend requires storage to be configured for award images.
Filesystem
awards:
storage:
fs:
directory: my-directory
GCS
awards:
storage:
gcs:
bucket: gs://backstage-awards
keyFilename: path/to/keyFile.json
S3
awards:
storage:
s3:
bucket: backstage-awards
region: us-east-1
accessKeyId: ${AWS_ACCESS_KEY_ID}
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
endpoint: http://127.0.0.1:4566
Slack notifications (optional)
To enable Slack notifications, add the following to your app-config.yaml
file:
awards:
notifications:
slack:
webhook:
url: ${MY_SLACK_WEBHOOK_URL_ENV_VAR}
Users who have the slack.com/user_id
annotation set (see slack-catalog-backend) will be tagged in notifications that pertain to them.
Developing this plugin
The plugin can be executed in isolation during development by running
yarn start
in the plugin root directory. This method of serving the plugin
provides quicker iteration speed and a faster startup and hot reloads.
It is only meant for local development, and the setup for it can be found
inside the /dev directory.