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.
Install the @seatgeek/backstage-plugin-awards-backend package in your backend package:
# From your Backstage root directory
yarn add --cwd packages/backend @seatgeek/backstage-plugin-awards-backend
Then create a plugin entry inside packages/src/plugins/awards.ts
in your
Backstage root with the following content:
import { createRouter } from '@seatgeek/backstage-plugin-awards-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
return await createRouter({
logger: env.logger,
database: env.database,
identity: env.identity,
});
}
Import the plugin inside packages/backend/src/index.ts
in your Backstage root:
// Other imports here
import awards from './plugins/awards';
function makeCreateEnv(config: Config) {
// Lots of code here. Add the following line before the router is instantiated.
const awardsEnv = useHotMemoize(module, () => createEnv('awards'));
const apiRouter = Router();
// Several apiRouter.use() statements here.
// Add the route for /awards as the last one before the notFoundHandler() is
// setup.
apiRouter.use('/awards', await awards(awardsEnv));
apiRouter.use(notFoundHandler());
}
The awards-backend requires storage to be configured for award images.
awards:
storage:
fs:
# directory where files will be stored relative to the CWD where the application was started
directory: my-directory # optional: defaults to tmp-awards-storage
awards:
storage:
gcs:
bucket: gs://backstage-awards # required
keyFilename: path/to/keyFile.json # optional: defaults to GOOGLE_APPLICATION_CREDENTIALS
awards:
storage:
s3:
bucket: backstage-awards # required
region: us-east-1 # required
# Omit the following fields if using IAM roles (https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/loading-node-credentials-iam.html)
accessKeyId: ${AWS_ACCESS_KEY_ID} # optional
secretAccessKey: ${AWS_SECRET_ACCESS_KEY} # optional
# For local development, pass the endpoint for your localstack server
endpoint: http://127.0.0.1:4566 # optional
To enable Slack notifications, add the following to your app-config.yaml
file:
awards:
notifications:
slack:
webhook:
# https://api.slack.com/messaging/webhooks
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.
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.