glen/slack-unfurl

Extensible Slack App for link unfurling

Extensible Slack App for link unfurling

Slack app for unfurling issue links, _(*1)

Slack App

Create or Manage your app., _(*2)

You need Verification Token (SLACK_VERIFICATION_TOKEN) for next step., _(*3)

Under Features: - enable Events API for link_shared event with links:read scope. 1. Click Event Subscriptions on the left. 2. Click Enable Events. 3. Click Add Workspace Event and add link_shared. 4. Click Add Domain and type your domain. 5. Click Save Changes. - add links:write permission scope 1. Click OAuth & Permissions on the left. 2. Go to Scopes section and select Add link previews to messages in the list of permissions. 3. Click Save Changes. - enable Incoming Webhooks, _(*4)

Obtain OAuth Access Token (SLACK_API_TOKEN) under OAuth & Permissions, _(*5)

Configuration

cp env.example .env

Adding providers

The app itself handles no links, you need to add some providers:, _(*6)

• Eventum Provider
• GitLab Provider
• Jira Provider
• Zendesk Provider
• Pagerduty Provider

Troubleshoot

If the unfurl is not happening check that the domain is not blacklisted., _(*7)

If you modify app domains, you need to Install App (/install-on-team as url) again to re-authorize: - https://api.slack.com/reference/messaging/link-unfurling#configuring_domains, _(*8)

Development

Install composer deps and start builtin HTTP server:, _(*9)

composer install
composer run server

To build docker image locally and run it:, _(*10)

docker build -t slack-unfurl .
docker run --rm -p 4390:4390 -v $(pwd)/var/log:/app/var/log -v $(pwd)/.env:/app/.env slack-unfurl

The service is accessible from http://slack-unfurl.127.0.0.1.xip.io:4390/ or just http://localhost:4390/, _(*11)