Franklin Chat Service

• Slack app:
  • https://api.slack.com/apps/AA4TSRLKV (AEM Engineering)
  • https://api.slack.com/apps/A056A7R316Z (Adobe Enterprise Support)
• Passwordless login: MagicLink
• E-mail to channel mapping: Google Spreadsheet

Running locally

• add the following properties to .env
  • SERVER_PORT
  • MAGIC_LINK_API_KEY=...
  • CHANNEL_MAPPING_URL=...
  • SLACK_BOT_TOKEN (OAuth & Permissions > Bot User OAuth Token)
  • SLACK_APP_TOKEN (Basic Information > App-Level Tokens > "App Token")
  • SLACK_ADMIN_CHANNEL_ID (Slack channel id where the admin messages are sent to - note: slack app above needs to be invited to the channel)
  • LOG_LEVEL={debug|info|warn|error}
  • GRAFANA_ENABLED=...
  • GRAFANA_HOST=...
  • GRAFANA_USER_ID=...
  • GRAFANA_PASSWORD=...
  • GRAFANA_APP_NAME=...
• npm start

Deploying to Ethos

• add the following properties to .env
  • DOCKER_IMAGE_NAME
  • DOCKER_REGISTRY_URL
  • DOCKER_USERNAME
  • DOCKER_PASSWORD
  • DEPLOYMENT_NAME
  • CLUSTER_NAME
  • NAMESPACE
• npm run build:docker
• npm run deploy

Rest API

• Heath check: /health
• Metrics: /metrics
• Admin panel: /admin

Troubleshooting

The logs are sent to Grafana Cloud and can be inspected here

Development

You can use npm run dev to run the service in dev mode: watch for changes in TS files and open the inspect port.
To override the production environment variables, create a .env.local file and add the variables you want to override.