The application behind the tech404 automatic invitation system
To enqueue an invitation request:
curl -X POST \
-H "Content-Type: application/json" \
-d "{\"email\":\"[email protected]\"}" \
http://localhost:3000/invitationsThe route is meant to be used by a JavaScript client. Browsers will require CORS to be setup correctly: you can whitelist CORS origins in config/application.rb. Other applications (e.g., curl) do not require CORS.
Pointing your web browser at the /sidekiq endpoint will give you access to Sidekiq's built-in dashboard. User the username and password you set in the environmental variables below.
Configuration items are stored in environment variables.
- SLACK_SUBDOMAIN: e.g., tech404 for tech404.slack.com
- SLACK_TOKEN: an API token for an administrator of the organization (more details)
- SIDEKIQ_USERNAME: username for the sidekiq administration area
- SIDEKIQ_PASSWORD: password for the sidekiq administration area
- REDIS_PROVIDER: pointer to the configuration variable where a Redis URL is stored (more details)
The REDIS_PROVIDER configuration variable should point to the configuration variable where the Redis URL is set.
For example, to use Redis Cloud on Heroku:
heroku addons:add rediscloud
heroku config:set REDIS_PROVIDER=REDISCLOUD_URL
A normal Slack API token will not work correctly. To retrieve an API token that can be used for invitations, navigate to the invitation page on the Slack web interface (as if you were going to manually invite someone), view the source of the page, and extract the api_token. Use this value as SLACK_TOKEN.
Do not logout of the session where the token was generated. If the token becomes invalid, requests will fail and queue up. To resolve the issue, generate a new token. Sidekiq will eventually re-run the jobs.
- PostgreSQL:
brew install postgresql - Redis:
brew install redis
Deployed on Heroku. Ask @alindeman for access. In production, we run a puma process in the same dyno as a sidekiq worker. It's a hack to keep it free.